Skip to content

Commit ac6f0ee

Browse files
authored
(DOCSP-42990) Removes nested components in CM- batch 1 reference (#10… (#334)
Backports #333
1 parent 38a679a commit ac6f0ee

18 files changed

+77
-151
lines changed

source/includes/api/automation-configuration/backupVersions.rst

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -50,11 +50,9 @@ settings, use the :ref:`update-backup-logs` endpoint.
5050
- string
5151
- Required
5252
- Version of the Backup Agent.
53+
54+
To learn more, see :doc:`/reference/mongodb-compatibility`.
5355

54-
.. seealso::
55-
56-
:doc:`/reference/mongodb-compatibility`
57-
5856
.. important::
5957

6058
This property is read-only. Any modifications made to this

source/includes/api/automation-configuration/cluster-wide.rst

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,4 @@ replica set or sharded cluster without requiring a :opsmgr:`rolling restart </re
4343
parameter from its automation configuration, but not from the
4444
server.
4545

46-
.. seealso::
47-
48-
:manual:`changeStreamOptions </reference/cluster-parameters/#mongodb-parameter-param.changeStreamOptions.preAndPostImages.expireAfterSeconds>`.
46+
To learn more, see :manual:`changeStreamOptions </reference/cluster-parameters/#mongodb-parameter-param.changeStreamOptions.preAndPostImages.expireAfterSeconds>`.

source/includes/api/automation-configuration/indexConfigs.rst

Lines changed: 6 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -98,9 +98,8 @@ The **indexConfigs** array is optional and defines indexes to be built for speci
9898
This parameter applies only if you set
9999
**indexConfigs.collation.strength** to **1** or **2**.
100100

101-
.. seealso::
101+
To learn more, see :manual:`Collation </reference/collation>`.
102102

103-
:manual:`Collation </reference/collation>`
104103
* - indexConfigs.collation.caseFirst
105104
- string
106105
- Optional
@@ -141,9 +140,8 @@ The **indexConfigs** array is optional and defines indexes to be built for speci
141140

142141
The default is **false**.
143142

144-
.. seealso::
143+
To learn more, see :manual:`Collation </reference/collation>`.
145144

146-
:manual:`Collation </reference/collation>`
147145
* - indexConfigs.collation.alternate
148146
- string
149147
- Optional
@@ -172,9 +170,8 @@ The **indexConfigs** array is optional and defines indexes to be built for speci
172170

173171
The default is **false**.
174172

175-
.. seealso::
176-
177-
:manual:`Collation </reference/collation>`
173+
To learn more, see :manual:`Collation </reference/collation>`.
174+
178175
* - indexConfigs.collation.backwards
179176
- boolean
180177
- Optional
@@ -186,9 +183,8 @@ The **indexConfigs** array is optional and defines indexes to be built for speci
186183

187184
The default is **false**.
188185

189-
.. seealso::
190-
191-
:manual:`Collation </reference/collation>`
186+
To learn more, see :manual:`Collation </reference/collation>`.
187+
192188
* - indexConfigs.options
193189
- document
194190
- Required

source/includes/api/automation-configuration/monitoringVersions.rst

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -51,11 +51,9 @@ endpoint.
5151
- string
5252
- Required
5353
- Version of the Monitoring Agent.
54+
55+
To learn more, see :doc:`/reference/mongodb-compatibility`.
5456

55-
.. seealso::
56-
57-
:doc:`/reference/mongodb-compatibility`
58-
5957
.. important::
6058

6159
This property is read-only. Any modifications made to this

source/includes/api/automation-configuration/processes.rst

Lines changed: 17 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -67,11 +67,9 @@ instances. Using this array, you can:
6767
- Required
6868
- MongoDB configuration object for MongoDB versions 2.6 and later.
6969

70-
.. note::
71-
72-
The ``processes.args2_6`` object accepts most MongoDB
73-
settings and parameters for MongoDB versions 2.6 and later.
74-
To learn more, see :ref:`om-unsupported-mdb-settings`.
70+
The ``processes.args2_6`` object accepts most MongoDB
71+
settings and parameters for MongoDB versions 2.6 and later.
72+
To learn more, see :ref:`om-unsupported-mdb-settings`.
7573

7674
* - processes[n].alias
7775
- string
@@ -93,10 +91,8 @@ instances. Using this array, you can:
9391
- MongoDB 3.x and 4.x clusters default to **5**.
9492
- MongoDB 2.6 clusters default to **3**.
9593

96-
.. seealso::
97-
98-
:manual:`Upgrade to SCRAM-SHA-1 </release-notes/3.0-scram/>`
99-
in the MongoDB 3.0 release notes.
94+
To learn more, see :manual:`Upgrade to SCRAM-SHA-1
95+
</release-notes/3.0-scram/>` in the MongoDB 3.0 release notes.
10096

10197
* - processes[n].backupRestoreUrl
10298
- string
@@ -105,9 +101,7 @@ instances. Using this array, you can:
105101
restore. To cancel an in-progress restore operation, set this
106102
option to ``CANCEL``.
107103

108-
.. seealso::
109-
110-
:doc:`/tutorial/automate-backup-restoration-with-api`.
104+
To learn more, see :doc:`/tutorial/automate-backup-restoration-with-api`.
111105

112106
* - processes[n].cluster
113107
- string
@@ -183,9 +177,7 @@ instances. Using this array, you can:
183177
- |mms| doesn't automatically increment this parameter when you
184178
upgrade a host from one MongoDB version to the next.
185179

186-
.. seealso::
187-
188-
:manual:`setFeatureCompatibilityVersion </reference/command/setFeatureCompatibilityVersion/#dbcmd.setFeatureCompatibilityVersion>`
180+
To learn more, see :manual:`setFeatureCompatibilityVersion </reference/command/setFeatureCompatibilityVersion/#dbcmd.setFeatureCompatibilityVersion>`.
189181

190182
* - processes[n].hostname
191183
- string
@@ -237,29 +229,24 @@ instances. Using this array, you can:
237229
To trigger the init sync process on the node immediately, set
238230
this value to the current time as an |iso8601| timestamp.
239231

240-
.. warning::
241-
242-
Use this parameter with caution. During
243-
:manual:`initial sync </core/replica-set-sync/#replica-set-initial-sync>`,
244-
Automation removes the entire contents of the node's
245-
``dbPath`` directory.
232+
:red:`WARNING:` Use this parameter with caution. During
233+
:manual:`initial sync </core/replica-set-sync/#replica-set-initial-sync>`, Automation removes the entire
234+
contents of the node's ``dbPath`` directory.
246235

247236
If you set this parameter:
248237

249238
- On the secondary node, the {+mdbagent+} checks whether the
250239
specified timestamp is later than the time of the last resync,
251240
and if confirmed, starts init sync on this node.
252241

253-
.. example::
254-
255-
To set **processes.lastResync** on the secondary node to 28
256-
May 2021 at 2:43:52 PM US CentralStandard Time, use:
242+
For example, to set ``processes.lastResync`` on the secondary node to 28
243+
May 2021 at 2:43:52 PM US CentralStandard Time, use:
257244

258-
``"processes.lastResync" : "2021-05-28T14:43:52-06:00"``.
245+
``"processes.lastResync" : "2021-05-28T14:43:52-06:00"``
259246

260-
If the {+mdbagent+} confirms that this timestamp is later
261-
than the recorded time of the last resync, it starts init
262-
sync on the node.
247+
If the {+mdbagent+} confirms that this timestamp is later
248+
than the recorded time of the last resync, it starts init
249+
sync on the node.
263250

264251
- On the primary node, the {+mdbagent+} waits until you ask the
265252
primary node to become the secondary with the
@@ -275,9 +262,7 @@ instances. Using this array, you can:
275262
:method:`rs.stepDown` method, and then starts init sync on
276263
this node.
277264

278-
.. seealso::
279-
280-
:manual:`Initial Sync </core/replica-set-sync/#replica-set-initial-sync>`
265+
To learn more, see :manual:`Initial Sync </core/replica-set-sync/#replica-set-initial-sync>`.
281266

282267
* - processes[n].lastKmipMasterKeyRotation
283268
- string

source/includes/api/automation-configuration/replicaSets.rst

Lines changed: 5 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -74,9 +74,8 @@ This field is required for deployments with replica sets.
7474
configuration document: **_id**; **version**; and
7575
**members**.
7676

77-
.. seealso::
77+
To learn more, see :manual:`replSetGetConfig </reference/command/replSetGetConfig>`.
7878

79-
:manual:`replSetGetConfig </reference/command/replSetGetConfig>`
8079
* - replicaSets[n]._id
8180
- string
8281
- Required
@@ -96,9 +95,8 @@ This field is required for deployments with replica sets.
9695
**processes.name**. The {+mdbagent+} expands the **host** field
9796
to create a valid replica set configuration.
9897

99-
.. seealso::
98+
To learn more, see :manual:`replSetGetConfig </reference/command/replSetGetConfig>`.
10099

101-
:manual:`replSetGetConfig </reference/command/replSetGetConfig>`.
102100
* - replicaSets[n].members[m]._id
103101
- integer
104102
- Optional
@@ -174,10 +172,6 @@ This field is required for deployments with replica sets.
174172
{+mdbagent+} forces the replica set to use. Set to **-1** to
175173
force a replica set to accept a new configuration.
176174

177-
.. warning::
178-
179-
Forcing a replica set reconfiguration might lead to a
180-
:term:`rollback` of majority-committed writes.
181-
182-
Proceed with caution. Contact |mdb-support| if you have
183-
questions about the potential impacts of this operation.
175+
:red:`WARNING:` Forcing a replica set reconfiguration might lead
176+
to a :term:`rollback` of majority-committed writes. Proceed with caution. Contact |mdb-support| if you have
177+
questions about the potential impacts of this operation.

source/includes/api/automation-configuration/roles.rst

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -78,9 +78,8 @@ The ``roles`` array is optional and describes user-defined roles.
7878
- Conditional
7979
- Actions permitted on the resource.
8080

81-
.. seealso::
81+
To learn more, see :manual:`Privilege Actions </reference/privilege-actions/>`.
8282

83-
:manual:`Privilege Actions </reference/privilege-actions/>`
8483
* - roles[n].roles
8584
- array of documents
8685
- Conditional

source/includes/api/list-tables/auto-config/auth.rst

Lines changed: 7 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,7 @@
1414
- Defines :manual:`authentication-related </core/authentication>`
1515
settings.
1616

17-
.. note::
18-
19-
If you omit this parameter, skip the rest of this section.
17+
If you omit this parameter, skip the rest of this section.
2018

2119
* - auth.authoritativeSet
2220
- boolean
@@ -97,10 +95,8 @@
9795

9896
**Required if you enable authentication.**
9997

100-
.. note::
101-
102-
This parameter contains more than one element only when
103-
it's configured for both SCRAM-SHA-1 and SCRAM-SHA-256.
98+
This parameter contains more than one element only when
99+
it's configured for both SCRAM-SHA-1 and SCRAM-SHA-256.
104100

105101
Specify:
106102

@@ -134,10 +130,8 @@
134130

135131
Required if **you enable authentication** and **"auth.disabled" : false**.
136132

137-
.. note::
138-
139-
If you change the **auth.key** value, you must change the
140-
**auth.keyfile** value.
133+
If you change the **auth.key** value, you must change the
134+
**auth.keyfile** value.
141135

142136
* - auth.keyfile
143137
- string
@@ -147,10 +141,8 @@
147141

148142
Required if **you enable authentication** and **"auth.disabled" : false**.
149143

150-
.. note::
151-
152-
If you change the **auth.keyfile** value, you must change the
153-
**auth.key** value.
144+
If you change the **auth.keyfile** value, you must change the
145+
**auth.key** value.
154146

155147
* - | auth
156148
| .newAutoPwd

source/includes/api/list-tables/snapshot-cs-documents.rst

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -135,11 +135,8 @@
135135
- objectId
136136
- The :abbr:`KMIP (Key Management Interoperability Protocol)`
137137
master key ID used to encrypt the snapshot data.
138-
139-
.. note::
140-
141-
This parameter appears only if this snapshot has
142-
``parts.encryptionEnabled : true``.
138+
``parts.masterKeyUUID`` appears only if this snapshot has
139+
``parts.encryptionEnabled : true``.
143140

144141
* - parts.mongodVersion
145142
- string

source/includes/api/list-tables/snapshot-rs-documents.rst

Lines changed: 8 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -60,11 +60,9 @@
6060
* - | ``isPossibly``
6161
| ``Inconsistent``
6262
- boolean
63-
- Flag that indicates the consistency of this :manual:`snapshot </reference/glossary/#std-term-snapshot>`.
64-
65-
.. note::
66-
67-
This appears for :manual:`sharded cluster </reference/glossary/#std-term-sharded-cluster>` snapshots only.
63+
- Flag that indicates the consistency of this :manual:`snapshot </reference/glossary/#std-term-snapshot>`.
64+
``isPossiblyInconsistent`` appears for
65+
:manual:`sharded cluster </reference/glossary/#std-term-sharded-cluster>` snapshots only.
6866

6967
To take a snapshot of a :manual:`sharded cluster </reference/glossary/#std-term-sharded-cluster>` in a consistent
7068
state, the {+bagent+} temporarily turns off the
@@ -131,11 +129,8 @@
131129

132130
* - ``missingShards``
133131
- array of objects
134-
- List of shards that the :manual:`snapshot </reference/glossary/#std-term-snapshot>` is missing.
135-
136-
.. note::
137-
138-
This appears for :manual:`sharded cluster </reference/glossary/#std-term-sharded-cluster>` snapshots only.
132+
- List of shards that the :manual:`snapshot </reference/glossary/#std-term-snapshot>` is missing. ``missingShards`` appears for
133+
:manual:`sharded cluster </reference/glossary/#std-term-sharded-cluster>` snapshots only.
139134

140135
In steady state, this array is empty. If the {+bagent+} cannot
141136
connect to a shard when a :manual:`snapshot </reference/glossary/#std-term-snapshot>` is created, the shard
@@ -221,12 +216,9 @@
221216
* - | ``parts``
222217
| ``.masterKeyUUID``
223218
- string
224-
- |kmip| master key ID used to encrypt the :manual:`snapshot </reference/glossary/#std-term-snapshot>` data.
225-
226-
.. note::
227-
228-
This appears only if this snapshot has
229-
``parts.encryptionEnabled : true``.
219+
- |kmip| master key ID used to encrypt the :manual:`snapshot </reference/glossary/#std-term-snapshot>` data.
220+
``parts.masterKeyUUID`` appears only if this snapshot has
221+
``parts.encryptionEnabled : true``.
230222

231223
* - | ``parts``
232224
| ``.mongodVersion``

source/includes/extract-new-auto-pwd.rst

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,6 @@
66
#. **auth.newAutoPwd** copies over the **auth.autoPwd**
77
password automatically.
88

9-
.. note::
10-
11-
You can set this option only when you include SCRAM-SHA-1
12-
or SCRAM-SHA-256 as one of the authentication
13-
mechanisms for the {+aagent+} in **auth.autoAuthMechanisms**.
9+
You can set this option only when you include SCRAM-SHA-1
10+
or SCRAM-SHA-256 as one of the authentication
11+
mechanisms for the {+aagent+} in **auth.autoAuthMechanisms**.
Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,5 @@
1-
.. note::
1+
After you create a third-party integration that requires an API or
2+
integration key, the key appears partially redacted when you:
23

3-
After you create a third-party integration that requires an API or
4-
integration key, the key appears partially redacted when you:
5-
6-
- View or edit the alert through the UI.
7-
- Query the third-party integration settings through the |api|.
4+
- View or edit the alert through the UI.
5+
- Query the third-party integration settings through the |api|.
Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
1-
.. note::
2-
3-
When you view or edit the alert for a webhook
4-
notification, the URL appears partially redacted, and the
5-
secret appears completely redacted.
1+
When you view or edit the alert for a webhook
2+
notification, the URL appears partially redacted, and the
3+
secret appears completely redacted.
Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
1-
.. note::
2-
3-
All new PagerDuty keys use their `Events API v2 <https://developer.pagerduty.com/docs/ZG9jOjExMDI5NTgw-events-api-v2-overview>`__.
4-
If you have an Events API v1 key, you can continue to use that key
5-
with |mms|.
1+
All new PagerDuty keys use their `Events API v2 <https://developer.pagerduty.com/docs/ZG9jOjExMDI5NTgw-events-api-v2-overview>`__.
2+
If you have an Events API v1 key, you can continue to use that key
3+
with |mms|.
Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
1-
.. note::
2-
3-
After creating a webhook notification, the URL will appear
4-
partially redacted when you view or edit the alert, and the
5-
secret will appear completely redacted.
1+
After creating a webhook notification, the URL is
2+
partially redacted when you view or edit the alert, and the
3+
secret is completely redacted.

0 commit comments

Comments
 (0)