DOCSP-14865 update list table header rows for NextGen

Author: andf-mongodb

source/administration/security-checklist.txt

@@ -26,10 +26,10 @@ Pre-production Checklist/Considerations
   requires that all clients and servers provide valid credentials
   before they can connect to the system.
 
-.. see::
+See also:
 
-   - :doc:`/core/authentication`
-   - :doc:`/tutorial/enable-authentication`
+- :doc:`/core/authentication`
+- :doc:`/tutorial/enable-authentication`
 
 .. _security-checklist-role-based-access-control:
 
@@ -45,18 +45,16 @@ Configure Role-Based Access Control
   users and assign them only the roles they need to perform their
   operations. A user can be a person or a client application.
 
-  .. tip::
+  Note that a user can have privileges across different databases. If a
+  user requires privileges on multiple databases, create a
+  single user with roles that grant applicable database
+  privileges instead of creating the user multiple times in
+  different databases.
 
-     A user can have privileges across different databases. If a
-     user requires privileges on multiple databases, create a
-     single user with roles that grant applicable database
-     privileges instead of creating the user multiple times in
-     different databases.
+See also:
 
-.. see::
-
-   - :doc:`/core/authorization`
-   - :doc:`/tutorial/manage-users-and-roles`
+- :doc:`/core/authorization`
+- :doc:`/tutorial/manage-users-and-roles`
 
 |arrow| Encrypt Communication (TLS/SSL)
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -73,9 +71,7 @@ Configure Role-Based Access Control
 
      .. include:: /includes/fact-tls-1.0.rst
 
-.. see::
-
-   - :doc:`/tutorial/configure-ssl`.
+See also: :doc:`/tutorial/configure-ssl`.
 
 .. |binary| replace:: MongoDB
 
@@ -112,19 +108,19 @@ Configure Role-Based Access Control
 
      .. include:: /includes/fact-default-bind-ip-change.rst
 
-.. see::
-  
-   - :doc:`/core/security-hardening` 
+See also:
+
+- :doc:`/core/security-hardening` 
 
-   - the :setting:`net.bindIp` configuration setting
+- the :setting:`net.bindIp` configuration setting
 
-   - the :setting:`security.clusterIpSourceWhitelist` configuration
-     setting
+- the :setting:`security.clusterIpSourceWhitelist` configuration
+  setting
 
-   - the :ref:`authenticationRestrictions
-     <db-createUser-authenticationRestrictions>` field to the
-     :dbcommand:`db.createUser()` command to specify a per-user IP
-     whitelist.
+- the :ref:`authenticationRestrictions
+  <db-createUser-authenticationRestrictions>` field to the
+  :dbcommand:`db.createUser()` command to specify a per-user IP
+  whitelist.
 
 
 |arrow| Audit System Activity
@@ -140,10 +136,11 @@ Configure Role-Based Access Control
   up filters to record specific events, such as authentication
   events.
 
-.. see::
+See also:
 
-   - :doc:`/core/auditing`
-   - :doc:`/tutorial/configure-auditing`
+- :doc:`/core/auditing`
+
+- :doc:`/tutorial/configure-auditing`
 
 |arrow| Run MongoDB with a Dedicated User
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -152,9 +149,7 @@ Configure Role-Based Access Control
   account. Ensure that the account has permissions to access data
   but no unnecessary permissions.
 
-.. see::
-
-   - :doc:`/installation`
+See also: :doc:`/installation`
 
 .. _security-checklist-javascript:
 
@@ -173,9 +168,7 @@ Configure Role-Based Access Control
   This ensures that all documents stored by the
   :binary:`~bin.mongod` instance are valid :term:`BSON`.
 
-.. see::
-
-   - :doc:`/core/security-hardening`
+See also: :doc:`/core/security-hardening`
 
 |arrow| Request a Security Technical Implementation Guide (where applicable)
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

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

@@ -126,23 +126,30 @@ encrypted using a Customer Master Key (CMK) managed through a supported
 The :binary:`~bin.mongo` shell provides helper methods for data
 encryption key management:
 
-Retrieving data encryption keys
-   - :method:`KeyVault.getKey()`
-   - :method:`KeyVault.getKeys()`
-   - :method:`KeyVault.getKeyByAltName()`
-
-Creating or Modifying data encryption keys
-   - :method:`KeyVault.createKey()`
-   - :method:`KeyVault.addKeyAlternateName()`
-   - :method:`KeyVault.removeKeyAlternateName()`
-
-Removing data encryption keys
-   - :method:`KeyVault.deleteKey()`
-
-     .. important::
-        
-        Removing a data encryption key renders all fields encrypted
-        using that data encryption key as permanently unreadable.
+.. list-table::
+   :header-rows: 1
+   :widths: 60 40
+
+   * - Use Case
+     - Helper Methods
+
+   * - Retrieving data encryption keys
+     - | :method:`KeyVault.getKey()`
+       | :method:`KeyVault.getKeys()`
+       | :method:`KeyVault.getKeyByAltName()`
+
+   * - Creating or Modifying data encryption keys
+     - | :method:`KeyVault.createKey()`
+       | :method:`KeyVault.addKeyAlternateName()`
+       | :method:`KeyVault.removeKeyAlternateName()`
+
+   * - Removing data encryption keys
+     - :method:`KeyVault.deleteKey()`
+
+       .. important::
+          
+          Removing a data encryption key renders all fields encrypted
+          using that data encryption key as permanently unreadable.
 
 
 Applications with :authrole:`read` access to the key vault collection

source/core/transactions.txt

@@ -749,7 +749,7 @@ MongoDB provides various transactions metrics:
    :widths: 40 60
    :header-rows: 1
 
-   * - Via
+   * - Source
      - Returns
 
    * - | :method:`db.serverStatus()` method

source/faq/concurrency.txt

@@ -206,15 +206,16 @@ use for document level locking storage engines:
 
 .. _faq-concurrency-database-lock:
 
-Which administrative commands lock the database?
-------------------------------------------------
+Which administrative commands lock a database?
+----------------------------------------------
 
-Certain administrative commands can exclusively lock the database for
-extended periods of time. In some deployments, for large databases,
-you may consider taking the :binary:`~bin.mongod` instance offline so that
-clients are not affected. For example, if a :binary:`~bin.mongod` is part
-of a :term:`replica set`, take the :binary:`~bin.mongod` offline and let
-other members of the set service load while maintenance is in progress.
+Some administrative commands can exclusively lock a database for
+extended time periods. For large database deployments, you may consider
+taking the :binary:`~bin.mongod` instance offline so that clients are
+not affected. For example, if a :binary:`~bin.mongod` is part of a
+:term:`replica set`, take the :binary:`~bin.mongod` offline and let
+other members of the replica set process requests while maintenance is
+performed.
 
 Administrative Commands Taking Extended Locks
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -226,33 +227,66 @@ database level for extended periods:
 - :dbcommand:`collMod` command
 - :dbcommand:`compact` command
 - :dbcommand:`convertToCapped` command
-- :dbcommand:`renameCollection` command and corresponding
-  :method:`db.collection.renameCollection()` shell method (see below).
-       
-  .. versionchanged:: 4.2
 
-     If renaming a collection within the same database, the operation
-     takes an exclusive (W) lock on the source and target collections.
-     Prior to MongoDB 4.2, the operation takes an exclusive (W) lock on
-     the database when renaming within the same database.
+In addition, the :dbcommand:`renameCollection` command and corresponding
+:method:`db.collection.renameCollection()` shell method take the
+following locks depending on the version of MongoDB:
+
+.. list-table::
+   :header-rows: 1
+
+   * - Command
+
+     - MongoDB 4.2.2 or later
 
-     (For :dbcommand:`renameCollection` *only*) If the target namespace
-     is in a different database as the source collection, the locking
-     behavior is version dependent:
+     - MongoDB 4.2.0 - 4.2.1
 
-     - *(MongoDB 4.2.2 and later)* The operation takes an exclusive
-       (W) lock on the target database when renaming a collection
-       across databases and blocks other operations on that database
-       until it finishes.
+     - MongoDB 4.0.X and previous
 
-     - *(MongoDB 4.2.1 and earlier)* The operation takes a global
-       exclusive (W) lock when renaming a collection across
+
+   * - :dbcommand:`renameCollection`
+
+     - If renaming a collection within the same database, the
+       :dbcommand:`renameCollection` command takes an exclusive (W) lock
+       on the source and target collections.
+
+       If the target namespace is in a different database as the source
+       collection, The :dbcommand:`renameCollection` command takes an
+       exclusive (W) lock on the target database when renaming a
+       collection across databases and blocks other operations on that
+       database until it finishes.
+
+     - If renaming a collection within the same database, the
+       :dbcommand:`renameCollection` command takes an exclusive (W) lock
+       on the source and target collections.
+
+       If the target namespace is in a different database as the source
+       collection, The :dbcommand:`renameCollection` command takes a
+       global exclusive (W) lock when renaming a collection across
        databases and blocks other operations until it finishes.
 
+     - Prior to MongoDB 4.2, the :dbcommand:`renameCollection` command
+       takes an exclusive (W) lock on the database when renaming within
+       the same database.
+
+
+   * - :method:`~db.collection.renameCollection()`
+
+     - If renaming a collection within the same database, the
+       :method:`~db.collection.renameCollection()` method takes an
+       exclusive (W) lock on the source and target collections.
+
+     - (same behavior as MongoDB 4.2.2 or later)
+
+     - Prior to MongoDB 4.2, the
+       :method:`~db.collection.renameCollection()` method takes an
+       exclusive (W) lock on the database when renaming within the same
+       database.
+
 Administrative Commands Taking Brief Locks
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-The following administrative operations lock the database but only hold
+These administrative operations lock a database but only hold
 the lock for a very short time:
 
 - :dbcommand:`authenticate` command and corresponding
@@ -261,9 +295,7 @@ the lock for a very short time:
 - :dbcommand:`createUser` command and corresponding
   :method:`db.createUser()` shell method
 
-.. seealso::
-
-   :ref:`faq-concurrency-lock-multiple-dbs`
+  :ref:`faq-concurrency-lock-multiple-dbs`
 
 .. _faq-concurrency-collection-lock:
 
@@ -290,54 +322,52 @@ the collection level:
   :method:`db.collection.dropIndex()` and
   :method:`db.collection.dropIndexes()` shell methods
 
-- :dbcommand:`renameCollection` command and corresponding
-  :method:`db.collection.renameCollection()` shell method (see below)
-       
-  .. versionchanged:: 4.2
+- the :dbcommand:`renameCollection` command and corresponding
+  :method:`db.collection.renameCollection()` shell method take the
+  following locks, depending on version:
 
-     If renaming a collection within the same database, the operation
-     takes an exclusive (W) lock on the source and target collections.
-     Prior to MongoDB 4.2, the operation takes an exclusive (W) lock
-     on the database when renaming within the same database.
-
-     (:dbcommand:`renameCollection` *only*) If the target namespace is
-     in a different database as the source collection, the locking
-     behavior is version dependent:
-
-     - *MongoDB 4.2.2 and later* The operation takes an exclusive
-       (W) lock on the target database when renaming a collection
-       across databases and blocks other operations on that database
-       until it finishes.
-
-     - *MongoDB 4.2.1 and earlier* The operation takes a global
-       exclusive (W) lock when renaming a collection across
-       databases and blocks other operations until it finishes.
-
-- :dbcommand:`reIndex` command and corresponding
-  :method:`db.collection.reIndex()` shell method (see below)
-
-  .. versionchanged:: 4.2
-
-     - For MongoDB 4.2.2 and later, these operations obtain an
-       exclusive
-       (W) lock on the collection and block other operations on the
-       collection until finished.
+  - For :dbcommand:`renameCollection` and
+    :method:`db.collection.renameCollection()`: If renaming a
+    collection within the same database, the operation takes an
+    exclusive (W) lock on the source and target collections.
+    Prior to MongoDB 4.2, the operation takes an exclusive (W) lock
+    on the database when renaming within the same database.
+
+  - For :dbcommand:`renameCollection` *only*:: If the target namespace
+    is in a different database as the source collection, the locking
+    behavior is version dependent:
+
+    - *MongoDB 4.2.2 and later* The operation takes an exclusive
+      (W) lock on the target database when renaming a collection
+      across databases and blocks other operations on that database
+      until it finishes.
+
+    - *MongoDB 4.2.1 and earlier* The operation takes a global
+      exclusive (W) lock when renaming a collection across
+      databases and blocks other operations until it finishes.
+
+- the :dbcommand:`reIndex` command and corresponding
+  :method:`db.collection.reIndex()` shell method take the following
+  locks, depending on version:
+  
+  - For MongoDB 4.2.2 and later, these operations obtain an exclusive
+    (W) lock on the collection and block other operations on the
+    collection until finished.
 
-     - For MongoDB 4.0.0 through 4.2.1, these operations take a
-       global exclusive (W) lock and block other operations until
-       finished.
+  - For MongoDB 4.0.0 through 4.2.1, these operations take a
+    global exclusive (W) lock and block other operations until
+    finished.
 
-- :dbcommand:`replSetResizeOplog` command (see below)
+- the :dbcommand:`replSetResizeOplog` command takes the following locks,
+  depending on version:
 
-  .. versionchanged:: 4.2
-          
-     - For MongoDB 4.2.2 and later, this operation takes an exclusive 
-       (W) lock on the :data:`oplog <local.oplog.rs>` collection and 
-       blocks other operations on the collection until it finishes.
+  - For MongoDB 4.2.2 and later, this operation takes an exclusive 
+    (W) lock on the :data:`oplog <local.oplog.rs>` collection and 
+    blocks other operations on the collection until it finishes.
 
-     - For MongoDB 4.2.1 and earlier, this operation takes a global
-       exclusive (W) lock and blocks other operations until it
-       finishes.
+  - For MongoDB 4.2.1 and earlier, this operation takes a global
+    exclusive (W) lock and blocks other operations until it
+    finishes.
 
 Prior to MongoDB 4.2, these operations took an exclusive lock on the
 database, blocking all operations on the database *and* its collections