Skip to content

Commit 555e867

Browse files
committed
DOCSP-15327 final round NextGen cleanup
1 parent 1489794 commit 555e867

File tree

116 files changed

+416
-389
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

116 files changed

+416
-389
lines changed

source/about.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ Attribution-NonCommercial-ShareAlike 3.0 United States License
2727
|copy| MongoDB, Inc. 2008-|year|
2828

2929
Man Pages
30-
--------
30+
---------
3131

3232
In addition to the `MongoDB Manual <https://docs.mongodb.com/manual/#>`_, you can
3333
access the :manual:`MongoDB Man Pages </manpages.tar.gz>`,

source/administration/security-checklist.txt

Lines changed: 44 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -26,15 +26,17 @@ Pre-production Checklist/Considerations
2626
requires that all clients and servers provide valid credentials
2727
before they can connect to the system.
2828

29-
See also:
29+
|
3030

31-
- :doc:`/core/authentication`
32-
- :doc:`/tutorial/enable-authentication`
31+
See also:
32+
33+
- :doc:`/core/authentication`
34+
- :doc:`/tutorial/enable-authentication`
3335

3436
.. _security-checklist-role-based-access-control:
3537

36-
Configure Role-Based Access Control
37-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
38+
|arrow| Configure Role-Based Access Control
39+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3840

3941
- Create a user administrator **first**, then create additional
4042
users. Create a unique MongoDB user for each person/application
@@ -45,16 +47,19 @@ Configure Role-Based Access Control
4547
users and assign them only the roles they need to perform their
4648
operations. A user can be a person or a client application.
4749

48-
Note that a user can have privileges across different databases. If a
49-
user requires privileges on multiple databases, create a
50-
single user with roles that grant applicable database
51-
privileges instead of creating the user multiple times in
52-
different databases.
50+
.. note::
51+
52+
A user can have privileges across different databases. If a user
53+
requires privileges on multiple databases, create a single user
54+
with roles that grant applicable database privileges instead of
55+
creating the user multiple times in different databases.
56+
57+
|
5358

54-
See also:
59+
See also:
5560

56-
- :doc:`/core/authorization`
57-
- :doc:`/tutorial/manage-users-and-roles`
61+
- :doc:`/core/authorization`
62+
- :doc:`/tutorial/manage-users-and-roles`
5863

5964
|arrow| Encrypt Communication (TLS/SSL)
6065
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -71,7 +76,9 @@ See also:
7176

7277
.. include:: /includes/fact-tls-1.0.rst
7378

74-
See also: :doc:`/tutorial/configure-ssl`.
79+
|
80+
81+
See also: :doc:`/tutorial/configure-ssl`.
7582

7683
.. |binary| replace:: MongoDB
7784

@@ -108,19 +115,21 @@ See also: :doc:`/tutorial/configure-ssl`.
108115

109116
.. include:: /includes/fact-default-bind-ip-change.rst
110117

111-
See also:
118+
|
112119

113-
- :doc:`/core/security-hardening`
120+
See also:
114121

115-
- the :setting:`net.bindIp` configuration setting
116-
117-
- the :setting:`security.clusterIpSourceWhitelist` configuration
118-
setting
122+
- :doc:`/core/security-hardening`
119123

120-
- the :ref:`authenticationRestrictions
121-
<db-createUser-authenticationRestrictions>` field to the
122-
:dbcommand:`db.createUser()` command to specify a per-user IP
123-
whitelist.
124+
- the :setting:`net.bindIp` configuration setting
125+
126+
- the :setting:`security.clusterIpSourceWhitelist` configuration
127+
setting
128+
129+
- the :ref:`authenticationRestrictions
130+
<db-createUser-authenticationRestrictions>` field to the
131+
:method:`db.createUser()` command to specify a per-user IP
132+
whitelist.
124133

125134

126135
|arrow| Audit System Activity
@@ -136,11 +145,13 @@ See also:
136145
up filters to record specific events, such as authentication
137146
events.
138147

139-
See also:
148+
|
149+
150+
See also:
140151

141-
- :doc:`/core/auditing`
152+
- :doc:`/core/auditing`
142153

143-
- :doc:`/tutorial/configure-auditing`
154+
- :doc:`/tutorial/configure-auditing`
144155

145156
|arrow| Run MongoDB with a Dedicated User
146157
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -149,7 +160,9 @@ See also:
149160
account. Ensure that the account has permissions to access data
150161
but no unnecessary permissions.
151162

152-
See also: :doc:`/installation`
163+
|
164+
165+
See also: :doc:`/installation`
153166

154167
.. _security-checklist-javascript:
155168

@@ -168,7 +181,9 @@ See also: :doc:`/installation`
168181
This ensures that all documents stored by the
169182
:binary:`~bin.mongod` instance are valid :term:`BSON`.
170183

171-
See also: :doc:`/core/security-hardening`
184+
|
185+
186+
See also: :doc:`/core/security-hardening`
172187

173188
|arrow| Request a Security Technical Implementation Guide (where applicable)
174189
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

source/changeStreams.txt

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -118,6 +118,15 @@ The following example opens a change stream for a collection and
118118
iterates over the cursor to retrieve the change stream documents.
119119
[#start-time]_
120120

121+
----------
122+
123+
.. |arrow| unicode:: U+27A4
124+
125+
|arrow| Use the **Select your language** drop-down menu in the
126+
upper-right to set the language of the examples on this page.
127+
128+
----------
129+
121130
.. tabs-selector:: drivers
122131

123132
.. tabs-drivers::
@@ -308,6 +317,13 @@ open, the cursor remains open until one of the following occurs:
308317
Modify Change Stream Output
309318
---------------------------
310319

320+
----------
321+
322+
|arrow| Use the **Select your language** drop-down menu in the
323+
upper-right to set the language of the examples on this page.
324+
325+
----------
326+
311327
.. tabs-drivers::
312328

313329
.. tab::
@@ -482,6 +498,13 @@ the update operation. However, you can configure the change stream
482498
to return the most current majority-committed version of the updated
483499
document.
484500

501+
----------
502+
503+
|arrow| Use the **Select your language** drop-down menu in the
504+
upper-right to set the language of the examples on this page.
505+
506+
----------
507+
485508
.. tabs-drivers::
486509

487510
.. tab::

source/core/capped-collections.txt

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -116,8 +116,8 @@ Query Efficiency
116116
~~~~~~~~~~~~~~~~
117117

118118
Use natural ordering to retrieve the most recently inserted elements
119-
from the collection efficiently. This is (somewhat) analogous to tail
120-
on a log file.
119+
from the collection efficiently. This is similar to using the ``tail``
120+
command on a log file.
121121

122122
Aggregation ``$out``
123123
~~~~~~~~~~~~~~~~~~~~
@@ -166,7 +166,9 @@ collection using the ``max`` field as in the following document:
166166
documents if a collection reaches the maximum size limit before it
167167
reaches the maximum document count.
168168

169-
.. see:: :method:`db.createCollection()` and :dbcommand:`create`.
169+
.. see::
170+
171+
:method:`db.createCollection()` and :dbcommand:`create`.
170172

171173
.. _capped-collections-options:
172174

source/core/map-reduce-concurrency.txt

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,7 @@ Map-Reduce Concurrency
1010
:depth: 1
1111
:class: singlecol
1212

13-
.. admonition:: Aggregation Pipeline as an Alternative to Map-Reduce
14-
:class: note
13+
.. note:: Aggregation Pipeline as an Alternative to Map-Reduce
1514

1615
.. include:: /includes/fact-use-aggregation-not-map-reduce.rst
1716

source/core/map-reduce-sharded-collections.txt

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,7 @@ Map-Reduce and Sharded Collections
1010
:depth: 1
1111
:class: singlecol
1212

13-
.. admonition:: Aggregation Pipeline as an Alternative to Map-Reduce
14-
:class: note
13+
.. note:: Aggregation Pipeline as an Alternative to Map-Reduce
1514

1615
.. include:: /includes/fact-use-aggregation-not-map-reduce.rst
1716

source/core/read-isolation-consistency-recency.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -279,7 +279,7 @@ upper-right to set the language of this example.
279279

280280
----------
281281

282-
.. tabs-pillstrip:: languages
282+
.. tabs-selector:: drivers
283283

284284
.. tabs-drivers::
285285

source/core/replica-set-high-availability.txt

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
1-
: replica set; failover
21
.. _replica-set-failover-administration:
32
.. _replica-set-failover:
43
.. _failover:

source/core/replica-set-rollbacks.txt

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,3 @@
1-
2-
single: replica set; rollbacks
3-
single: consistency; rollbacks
4-
51
.. _replica-set-rollbacks:
62
.. _replica-set-rollback:
73

@@ -58,7 +54,6 @@ By default, when a rollback occurs, MongoDB writes the rollback data to
5854
:term:`BSON` files.
5955

6056
.. note:: Rollback Directory Change
61-
6257

6358
Starting in Mongo 4.4, the rollback directory for a collection is named
6459
after the collection's UUID rather than the collection namespace.

source/core/security-client-side-encryption.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -413,7 +413,7 @@ the following official 4.2-compatible driver versions:
413413
- Supported Versions
414414
- Quickstarts / Tutorials
415415

416-
* - :driverecosystem:`Node </node>`
416+
* - :driver:`Node </node>`
417417
- ``3.4.0+``
418418
- | `Node.js Quickstart <https://mongodb.github.io/node-mongodb-native/3.4/reference/client-side-encryption/>`__
419419
| :driver:`Client-Side Field Level Encryption Guide </security/client-side-field-level-encryption-guide>`

0 commit comments

Comments
 (0)