DOCS-3350: minor edits

Author: Sam Kleinman

source/includes/fact-2.0-fsync-lock-change.rst

@@ -1,10 +1,10 @@
 title: Flush writes to disk and lock the database to prevent further writes.
 stepnum: 1
 ref: flush
+pre: |
+  To flush writes to disk and to "lock" the database, issue the
+  :method:`db.fsyncLock()` method in the :program:`mongo` shell:
 action:
-  pre: |
-    To flush writes to disk and to "lock" the database, issue the
-    :method:`db.fsyncLock()` method in the :program:`mongo` shell:
   language: javascript
   code: |
     db.fsyncLock();
@@ -16,15 +16,13 @@ ref: backup
 title: "After the snapshot completes, unlock the database."
 stepnum: 3
 ref: unlock
+pre: |
+  To unlock the database after the snapshot has completed, use the
+  following command in the :program:`mongo` shell:
 action:
-  - pre: |
-      To unlock the database after the snapshot has completed, use the
-      following command in the :program:`mongo` shell:
-    language: javascript
-    code: |
-      db.fsyncUnlock();
+  language: javascript
+  code: |
+    db.fsyncUnlock();
 post: |
   .. include:: /includes/warning-fsync-lock-mongodump.rst
-
-  .. include:: /includes/fact-2.0-fsync-lock-change.rst
 ...

source/includes/steps-backup-without-journaling.yaml

@@ -1,11 +1,12 @@
 title: "Start :program:`mongod` using the option to replace the original files with the repaired files."
 stepnum: 1
 ref: start-with-repair
+pre: |
+  Start the :program:`mongod` instance using the :option:`--repair
+  <mongod --repair>` option **and** the :option:`--repairpath
+  <mongod --repairpath>` option. Issue a command similar to the
+  following:
 action:
-  pre: |
-    Start the :program:`mongod` instance using the :option:`--repair
-    <mongod --repair>` option **and** the :option:`--repairpath <mongod
-    --repairpath>` option. Issue a command similar to the following:
   language: sh
   code: |
     mongod --dbpath /data/db --repair --repairpath /data/db0
@@ -16,10 +17,10 @@ post: |
 title: "Start :program:`mongod` with the new data directory."
 stepnum: 2
 ref: start-with-new-path
+pre: |
+  Start :program:`mongod` using the following invocation to point the
+  :setting:`~storage.dbPath` at ``/data/db0``:
 action:
-  pre: |
-    Start :program:`mongod` using the following invocation to point the
-    :setting:`~storage.dbPath` at ``/data/db0``:
   language: sh
   code: |
     mongod --dbpath /data/db0

source/includes/steps-recover-data-with-repairpath.yaml

@@ -14,11 +14,11 @@ post: |
 title: "Start :program:`mongod` using the option to replace the original files with the repaired files."
 stepnum: 2
 ref: start-with-repair
+pre: |
+  Start the :program:`mongod` instance using the :option:`--repair
+  <mongod --repair>` option, which replaces the original data files with
+  the repaired data files. Issue a command similar to the following:
 action:
-  pre: |
-    Start the :program:`mongod` instance using the :option:`--repair
-    <mongod --repair>` option, which replaces the original data files with
-    the repaired data files. Issue a command similar to the following:
   language: sh
   code: |
     mongod --dbpath /data/db --repair
@@ -29,10 +29,10 @@ post: |
 title: "Start :program:`mongod` as usual."
 stepnum: 3
 ref: start-as-usual
+pre: |
+  Start :program:`mongod` using the following invocation to point the
+  :setting:`~storage.dbPath` at ``/data/db``:
 action:
-  pre: |
-    Start :program:`mongod` using the following invocation to point the
-    :setting:`~storage.dbPath` at ``/data/db``:
   language: sh
   code: |
     mongod --dbpath /data/db

source/includes/steps-recover-data-without-repairpath.yaml

@@ -16,23 +16,23 @@ content: |
 title: "Start a :program:`mongod` using data files from the backup as the data path."
 stepnum: 2
 ref: start
+pre: |
+  The following example uses ``/data/db`` as the data path, as specified
+  in the :setting:`dbpath` setting:
 action:
-  pre: |
-    The following example uses ``/data/db`` as the data path, as specified
-    in the :setting:`dbpath` setting:
   language: sh
   code: |
     mongod --dbpath /data/db
 ---
 title: "Convert the standalone :program:`mongod` to a single-node replica set"
 stepnum: 3
 ref: convert
+pre: |
+  Convert the standalone :program:`mongod` process to a single-node
+  replica set by shutting down the :program:`mongod` instance, and
+  restarting it with the :option:`--replSet <mongod --replSet>` option,
+  as in the following example:
 action:
-  pre: |
-    Convert the standalone :program:`mongod` process to a single-node
-    replica set by shutting down the :program:`mongod` instance, and
-    restarting it with the :option:`--replSet <mongod --replSet>` option,
-    as in the following example:
   language: sh
   code: |
     mongod --dbpath /data/db --replSet <replName>
@@ -44,19 +44,21 @@ post: |
 title: Connect to the :program:`mongod` instance.
 stepnum: 4
 ref: connect
+pre: |
+  For example, first use the following command to a :program:`mongod`
+  instance running on the localhost interface:
 action:
-  pre: |
-    For example, first issue the following to connect:
   language: sh
   code: |
     mongo
 ---
 title: Initiate the new replica set.
 stepnum: 5
 ref: initiate
+pre: |
+  Use :method:`rs.initiate()` to initiate the new replica set, as in
+  the following example:
 action:
-  pre: |
-    Issue :method:`rs.initiate()` to initiate the new replica set. For example:
   language: javascript
   code: |
     rs.initiate()

source/includes/steps-restore-primary-from-backup.yaml

@@ -6,7 +6,7 @@ pre: |
   all shards *and* all config servers.
 action:
   pre: |
-    Connect to each member and issue the following:
+    Connect to each member use the following operation:
   language: javascript
   code: |
     use admin
@@ -33,11 +33,11 @@ action:
 title: Restart the config servers.
 stepnum: 3
 ref: restart-config-servers
+pre: |
+  Restart each :ref:`config server <sharding-config-server>`
+  :program:`mongod` instance by issuing a command similar to the
+  following for each, using values appropriate to your configuration:
 action:
-  pre: |
-    Restart each :ref:`config server <sharding-config-server>`
-    :program:`mongod` instance by issuing a command similar to the
-    following for each, using values appropriate to your configuration:
   language: sh
   code: |
     mongod --configsvr --dbpath /data/configdb --port 27019
@@ -67,11 +67,11 @@ content: |
 title: "Connect to a :program:`mongos` to ensure the cluster is operational."
 stepnum: 7
 ref: ensure
+pre: |
+  Connect to a :program:`mongos` instance from a :program:`mongo` shell
+  and use the :method:`db.printShardingStatus()` method to ensure that
+  the cluster is operational, as follows:
 action:
-  pre: |
-    Connect to a :program:`mongos` instance from a :program:`mongo` shell
-    and use the :method:`db.printShardingStatus()` method to ensure that
-    the cluster is operational, as follows:
   language: javascript
   code: |
     db.printShardingStatus()

source/includes/steps-restore-sharded-cluster-with-snapshots.yaml

@@ -22,8 +22,21 @@ particular.
 
 .. include:: /includes/note-shard-cluster-backup.rst
 
-Procedure
----------
+Considerations
+--------------
+
+Balancing
+~~~~~~~~~
+
+It is *essential* that you stop the balancer before capturing a
+backup.
+
+If the balancer is active while you capture backups, the backup
+artifacts may be incomplete and/or have duplicate data, as :term:`chunks
+<chunk>` may migrate while recording backups.
+
+Precision
+~~~~~~~~~
 
 In this procedure, you will stop the cluster balancer and take a backup
 up of the :term:`config database`, and then take backups of each
@@ -37,11 +50,7 @@ of the backup while minimizing impact on the cluster by taking the
 backup from a secondary member of the replica set that provides each
 shard.
 
-.. warning::
-
-   It is essential that you stop the balancer before creating
-   backups. If the balancer remains active, your resulting backups
-   could have duplicate data or miss some data, as :term:`chunks
-   <chunk>` may migrate while recording backups.
+Procedure
+---------
 
 .. include:: /includes/steps/backup-sharded-cluster-with-snapshots.rst