Skip to content

Commit b6afcd8

Browse files
authored
(DOCSP-43046) [OM] OM nested components group 11 (#398)
## Unnesting components in 19 OM pages. [This spreadsheet](https://docs.google.com/spreadsheets/d/1M2IlsyV0-6mY-AvBBrX-4uSDtQrbt9zuoXsqIJaVqlk/edit?gid=0#gid=0) tracks the number of nested components on each page, and [this doc](https://docs.google.com/document/d/1yMbng-EPOQ82bAzBTC2VJwIvsUBOSCJh21cGbDoe1a8/edit#heading=h.7hxlffls9cx6) provides guidelines for fixing nested components. ## [DOCSP-43046](https://jira.mongodb.org/browse/DOCSP-43046) ## STAGING 1. [ops-manager/current/reference/api/kmip-keys/get-master-key/](https://deploy-preview-398--10gen-docs-ops-manager.netlify.app/reference/api/kmip-keys/get-master-key/) — Unnested 1 note in table. 2. [ops-manager/current/reference/api/kmip-keys/rotate-master-key/](https://deploy-preview-398--10gen-docs-ops-manager.netlify.app/reference/api/kmip-keys/get-master-key/) — Unnested 1 note in table: same note as above. 3. [ops-manager/current/reference/api/organizations/organization-create-one/](https://deploy-preview-398--10gen-docs-ops-manager.netlify.app/reference/api/organizations/organization-create-one/) — Unnested 1 note in table. 4. [ops-manager/current/reference/api/diagnostics/get-project-diagnostic-archive/](https://deploy-preview-398--10gen-docs-ops-manager.netlify.app/reference/api/diagnostics/get-project-diagnostic-archive/) — Unnested 1 example in table. 5. [ops-manager/current/reference/api/backup/get-all-backup-configs-for-group/](https://deploy-preview-398--10gen-docs-ops-manager.netlify.app/reference/api/backup/get-all-backup-configs-for-group/) — Unnested 1 note in table, same note as above (1 and 2) 6. [ops-manager/current/reference/api/backup/get-one-backup-config-by-cluster-id/](https://deploy-preview-398--10gen-docs-ops-manager.netlify.app/reference/api/backup/get-one-backup-config-by-cluster-id/) — Unnested 1 note in table, same note as above (1 and 2) 7. [ops-manager/current/reference/api/user-create-first/](https://deploy-preview-398--10gen-docs-ops-manager.netlify.app/reference/api/user-create-first/) — Unnested 2 notes in tables. 8. [ops-manager/current/reference/config/ui-settings/](https://deploy-preview-398--10gen-docs-ops-manager.netlify.app/reference/config/ui-settings/) — Unnested 1 example in ``important`` admonition; note: could not find the 1 admonition in table listed on the spreadsheet 9. [ops-manager/current/reference/configuration/ ](https://deploy-preview-398--10gen-docs-ops-manager.netlify.app/reference/configuration/)— Unnested 1 note in ``important`` admonition in DOCSP-43011, unnested 1 ``important`` admonition in table and couldn't find the other admonition in table listed in the spreadsheet, unnested 1 example in table, and unnested 4 examples in ``important`` admonitions (2 of which were the same include) 10. [ops-manager/current/reference/firewall-configuration/](https://deploy-preview-398--10gen-docs-ops-manager.netlify.app/reference/firewall-configuration/) — Unnested 1 ``important`` admonition. 11. [ops-manager/current/release-notes/automation-agent/](https://deploy-preview-398--10gen-docs-ops-manager.netlify.app/release-notes/automation-agent/) — Entire page was wrapped in a note-- unindented the page so that the page is no longer nested. 12. [ops-manager/current/release-notes/backup-agent/](https://deploy-preview-398--10gen-docs-ops-manager.netlify.app/release-notes/backup-agent/) — Unindented page that was wrapped in a note. 13. [ops-manager/current/tutorial/manage-projects/](https://deploy-preview-398--10gen-docs-ops-manager.netlify.app/tutorial/manage-projects/) — Unnested 1 note in table. Note: Couldn't find 2 admonitions in table listed in the spreadsheet. 14. [ops-manager/current/tutorial/manage-s3-blockstore-storage/](https://deploy-preview-398--10gen-docs-ops-manager.netlify.app/tutorial/manage-s3-blockstore-storage/) — Unnested 3 examples and 7 admonitions in tables. 15. [ops-manager/current/tutorial/manage-s3-oplog-storage/](https://deploy-preview-398--10gen-docs-ops-manager.netlify.app/tutorial/manage-s3-oplog-storage/) — Unnested 2 examples, 2 notes, and 2 ``important`` admonitions in tables. 16. [ops-manager/current/tutorial/prepare-backing-mongodb-instances/](https://deploy-preview-398--10gen-docs-ops-manager.netlify.app/tutorial/prepare-backing-mongodb-instances/) — Unnested 1 warning in table. 17. [ops-manager/current/tutorial/view-logs/](https://deploy-preview-398--10gen-docs-ops-manager.netlify.app/tutorial/view-logs/) — Unnested 3 notes and 1 example in table. 18. [ops-manager/current/tutorial/update-om-with-latest-version-manifest-with-api/](https://deploy-preview-398--10gen-docs-ops-manager.netlify.app/tutorial/update-om-with-latest-version-manifest-with-api/) — Unnested 1 example in table and 1 example in tip. 19. [ops-manager/current/tutorial/upgrade-ops-manager/](https://deploy-preview-398--10gen-docs-ops-manager.netlify.app/tutorial/upgrade-ops-manager/) — Unnested 3 tips and 1 ``important`` admonition in table. ## [LATEST BUILD LOG](https://app.netlify.com/sites/10gen-docs-ops-manager/deploys/66fc4150994f6a0008c96d81) ### Self-Review Checklist - [ ] [Define](https://wiki.corp.mongodb.com/display/DE/Taxonomy+tagging+instructions) taxonomy [values](https://wiki.corp.mongodb.com/display/DE/Docs+Taxonomy) at top of page. - [ ] Add genre facets (tutorial or reference), as in this [example PR](10gen/cloud-docs#5042). - [ ] Add programmingLanguage (if necessary). - [ ] Add meta keywords (if necessary). - [x] Resolve any new warnings or errors in the build. - [x] Proofread for spelling and grammatical errors. - [x] Check staging for rendering issues. - [x] Confirm links are working. --------- Co-authored-by: Elyse Foreman <[email protected]>
1 parent f09b82b commit b6afcd8

26 files changed

+256
-304
lines changed

source/includes/extracts-firewall-configuration.yaml

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -86,11 +86,10 @@ content: |
8686
.. code-block:: http
8787
8888
http://127.0.0.1:8090/health
89-
90-
.. important::
91-
This port is only accessible from ``localhost``
92-
(or ``127.0.0.1``). The port number *can* be changed from
93-
``8090`` to another value.
89+
90+
:gold:`IMPORTANT:` This port is only accessible from ``localhost``
91+
(or ``127.0.0.1``). The port number *can* be changed from
92+
``8090`` to another value.
9493
9594
9695
The |api| endpoint provides the ability to check connections

source/includes/facts/upgrade-to-om-4-2-24.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,8 @@ An unintentional and temporary disabling of |tls| occurs when
22
upgrading to versions earlier than 4.2.24. Upgrading to 4.2.24
33
or later first avoids this outcome.
44

5-
.. seealso::
5+
To learn more, see:
66

7-
- :ref:`Ops Manager 4.2.23 release notes <opsmgr-server-4.2.23>`
8-
- :ref:`Ops Manager 4.2.24 release notes <opsmgr-server-4.2.24>`
9-
- `CVE-2021-20335 <https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2021-20335>`__
7+
- :ref:`Ops Manager 4.2.23 release notes <opsmgr-server-4.2.23>`
8+
- :ref:`Ops Manager 4.2.24 release notes <opsmgr-server-4.2.24>`
9+
- `CVE-2021-20335 <https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2021-20335>`__
Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,7 @@
1-
.. note::
1+
|fcv-link| ``4.2`` and later use
2+
:manual:`backup cursors </reference/glossary/#std-term-backup-cursor>` instead of
3+
:opsmgr:`head databases </reference/glossary/#std-term-head-database>`. For
4+
more information, see :ref:`backup-daemon`.
25

3-
FCV |fcv-link| ``4.2`` and later use
4-
:manual:`backup cursors </reference/glossary/#std-term-backup-cursor>` instead of
5-
:opsmgr:`head databases </reference/glossary/#std-term-head-database>`. For
6-
more information, see :ref:`backup-daemon`.
7-
8-
For more information on backup encryption for FCV 4.2 or
9-
later, see :ref:`encrypt-snapshots`.
6+
For more information on backup encryption for FCV 4.2 or
7+
later, see :ref:`encrypt-snapshots`.

source/includes/list-tables/api-tutorial-substitution-fields-version-manifest.rst

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,4 @@
2323
- string
2424
- Major and minor version of your |onprem| instance.
2525

26-
.. example::
27-
28-
``4.2``
26+
For example, ``4.2``.

source/includes/setting-fileConf-mms.agentCentralUrl.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,10 +14,10 @@
1414
address, you must enclose the |ipv6| address in square brackets
1515
(``[ ]``) to separate it from its port number.
1616

17-
.. example::
17+
For example:
1818

19-
.. code-block:: ini
19+
.. code-block:: ini
2020
21-
http://[2600:1f16:777:8700:93c2:b99c:a875:2b10]:8080
21+
http://[2600:1f16:777:8700:93c2:b99c:a875:2b10]:8080
2222
2323

source/includes/setting-fileConf-mms.backupCentralUrl.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,10 +14,10 @@
1414
address, you must enclose the |ipv6| address in square brackets
1515
(``[ ]``) to separate it from its port number.
1616

17-
.. example::
17+
For example:
1818

19-
.. code-block:: ini
19+
.. code-block:: ini
2020
21-
http://[2600:1f16:777:8700:93c2:b99c:a875:2b10]:8080
21+
http://[2600:1f16:777:8700:93c2:b99c:a875:2b10]:8080
2222
2323

source/includes/setting-fileConf-mms.centralUrl.rst

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -8,23 +8,23 @@
88
To use a port other than ``8080``, see
99
:doc:`/tutorial/manage-ports`.
1010

11+
.. code-block:: ini
12+
13+
mms.centralUrl=http://mms.example.com:8080
14+
15+
16+
Corresponds to :setting:`URL to Access Ops Manager`.
17+
1118
.. important::
1219

1320
If you plan on accessing your |application| using its |ipv6|
1421
address, you must enclose the |ipv6| address in square brackets
1522
(``[ ]``) to separate it from its port number.
1623

17-
.. example::
18-
19-
.. code-block:: ini
24+
For example:
2025

21-
http://[2600:1f16:777:8700:93c2:b99c:a875:2b10]:8080
26+
.. code-block:: ini
2227
23-
.. code-block:: ini
24-
25-
mms.centralUrl=http://mms.example.com:8080
26-
27-
28-
Corresponds to :setting:`URL to Access Ops Manager`.
28+
http://[2600:1f16:777:8700:93c2:b99c:a875:2b10]:8080
2929
3030

source/includes/setting-fileConf-mms.disableCiphers.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -53,11 +53,11 @@
5353
* - :guilabel:`Value`
5454
- ``<ciphers>``
5555

56-
.. example::
56+
For example:
5757

58-
.. code-block:: ini
58+
.. code-block:: ini
5959
60-
TLS_DHE_RSA_WITH_3DES_EDE_CBC_SHA, TLS_DHE_RSA_WITH_AES_256_CBC_SHA256
60+
TLS_DHE_RSA_WITH_3DES_EDE_CBC_SHA, TLS_DHE_RSA_WITH_AES_256_CBC_SHA256
6161
6262
.. warning::
6363

source/includes/setting-fileConf-mms.userSvcClass.rst

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -21,12 +21,10 @@
2121
* - Application Database
2222
- ``UserSvcDb``
2323

24-
.. important::
25-
26-
In |onprem| 6.0, the accepted value is
27-
``com.xgen.svc.mms.svc.user.UserSvcDb``.
28-
If you use this old accepted value, your |mms|
29-
instance will not start during preflight checks.
24+
:gold:`IMPORTANT:` In |onprem| 6.0, the accepted value is
25+
``com.xgen.svc.mms.svc.user.UserSvcDb``.
26+
If you use this old accepted value, your |mms|
27+
instance will not start during preflight checks.
3028

3129
* - |ldap|
3230
- ``UserSvcLdap``

source/includes/setting-uiConf-url-to-access-ops-manager.rst

Lines changed: 11 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -8,23 +8,22 @@
88
To use a port other than ``8080``, see
99
:doc:`/tutorial/manage-ports`.
1010

11+
.. code-block:: ini
12+
13+
http://mms.example.com:8080
14+
15+
Corresponds to :setting:`mms.centralUrl`.
16+
1117
.. important::
1218

1319
If you plan on accessing your |application| using its |ipv6|
1420
address, you must enclose the |ipv6| address in square brackets
1521
(``[ ]``) to separate it from its port number.
22+
23+
For example:
24+
25+
.. code-block:: ini
1626
17-
.. example::
18-
19-
.. code-block:: ini
20-
21-
http://[2600:1f16:777:8700:93c2:b99c:a875:2b10]:8080
22-
23-
.. code-block:: ini
24-
25-
http://mms.example.com:8080
26-
27-
28-
Corresponds to :setting:`mms.centralUrl`.
27+
http://[2600:1f16:777:8700:93c2:b99c:a875:2b10]:8080
2928
3029

source/includes/steps-add-group.yaml

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -22,13 +22,12 @@ content: |
2222
added to this project. This default type overrides the default
2323
type set for the parent organization.
2424
25-
.. include:: /includes/list-table-server-types.rst
26-
27-
.. note::
25+
You can change the server type for individual hosts.
26+
27+
You can modify this setting in
28+
:doc:`/tutorial/manage-project-settings`.
2829
29-
- You can modify this setting in
30-
:doc:`/tutorial/manage-project-settings`
31-
- You can change the server type for individual hosts.
30+
.. include:: /includes/list-table-server-types.rst
3231
3332
---
3433
title: "Configure |ldap| options."

source/includes/steps-admin-add-s3-blockstore.yaml

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -114,9 +114,11 @@ content: |
114114
the ``<hostname:port>`` format that comprise the blockstore
115115
metadata database.
116116
117-
.. example::
117+
For example:
118118
119-
``h1.ex.com:27017,h2.ex.com:27017,h2.ex.com:27018``
119+
.. code-block:: ini
120+
121+
h1.ex.com:27017,h2.ex.com:27017,h2.ex.com:27018
120122
121123
|mms| displays this field when you set
122124
:guilabel:`Datastore Type` to :guilabel:`Replica Set` or
@@ -141,16 +143,17 @@ content: |
141143
* - Username
142144
- Optional
143145
- If you set this value:
144-
146+
145147
.. include:: /includes/tabsets/storage-settings-username.rst
146148
147149
* - Password
148150
- Optional
149151
- If you set this value:
152+
153+
.. include:: /includes/tabsets/storage-settings-password.rst
150154
151155
.. include:: /includes/warning-plaintext-password.rst
152156
153-
.. include:: /includes/tabsets/storage-settings-password.rst
154157
155158
* - Connection Options
156159
- Optional

source/includes/steps-admin-add-s3-oplogstore.yaml

Lines changed: 10 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -120,18 +120,18 @@ content: |
120120
the ``<hostname:port>`` format that comprise the blockstore
121121
metadata database.
122122
123-
.. example::
123+
For example:
124124
125-
``host1.example.com:27017,host2.example.com:27017,host2.example.com:27018``
125+
.. code-block:: ini
126+
127+
host1.example.com:27017,host2.example.com:27017,host2.example.com:27018
126128
127129
|mms| displays this field when you set
128130
:guilabel:`Datastore Type` to :guilabel:`Replica Set` or
129131
:guilabel:`Sharded Cluster`.
130132
131-
.. important::
132-
133-
|onprem| uses this metadata store as a sync store. Make
134-
sure to provision this store with sufficient storage space.
133+
:gold:`IMPORTANT:` |onprem| uses this metadata store as a sync store. Make
134+
sure to provision this store with sufficient storage space.
135135
136136
* - MongoDB Hostname
137137
- Conditional
@@ -140,10 +140,8 @@ content: |
140140
|mms| displays this field when you set
141141
:guilabel:`Datastore Type` to :guilabel:`Standalone`.
142142
143-
.. important::
144-
145-
|onprem| uses this metadata store as a sync store. Make
146-
sure to provision this store with sufficient storage space.
143+
:gold:`IMPORTANT:` |onprem| uses this metadata store as a sync store. Make
144+
sure to provision this store with sufficient storage space.
147145
148146
* - MongoDB Port
149147
- Conditional
@@ -163,9 +161,9 @@ content: |
163161
- Optional
164162
- If you set this value:
165163
166-
.. include:: /includes/warning-plaintext-password.rst
167-
168164
.. include:: /includes/tabsets/storage-settings-password.rst
165+
166+
.. include:: /includes/warning-plaintext-password.rst
169167
170168
* - Connection Options
171169
- Optional

0 commit comments

Comments
 (0)