DOCSP-13972 clean shutdown notice for v4.4 downgrade docs

Author: jmd-mongo

source/includes/4.4-downgrade-clean-shutdown.rst

@@ -0,0 +1,8 @@
+Run the following command from the :binary:`~bin.mongo` shell to 
+perform a clean shutdown, or refer to 
+:ref:`terminate-mongod-processes` for additional ways to safely  
+terminate the :binary:`~bin.mongod` process:
+
+.. code-block:: javascript
+
+   db.adminCommand( { shutdown: 1 } )

source/includes/steps-4.4-downgrade-mongod.yaml

@@ -10,22 +10,28 @@ content: |
 
   .. include:: /includes/downgrade-path.rst
 ---
-title: "Restart with the latest |oldversion| ``mongod`` instance."
+title: "Shut down the ``mongod`` instance."
 level: 4
-ref: 4.4-downgrade-restart-instance
+ref: 4.4-downgrade-shutdown-instance
 content: |
-  Shut down your :binary:`~bin.mongod` instance. Replace the existing
-  binary with the downloaded :binary:`~bin.mongod` binary and restart.
-  
-  a. Shut down your :binary:`~bin.mongod` instance. To safely terminate
-     the :binary:`~bin.mongod` process, you can connect a
-     :binary:`~bin.mongo` shell to the instance and run:
+
+  To cleanly shut down the :binary:`~bin.mongod` process, connect a 
+  :binary:`~bin.mongo` shell to the instance and run:
      
-     .. code-block:: javascript
+  .. code-block:: javascript
 
-        db.adminCommand( { shutdown: 1 } )
+     db.adminCommand( { shutdown: 1 } )
+  
+  A :ref:`clean shutdown <terminate-mongod-processes>` of a 
+  :binary:`~bin.mongod` completes all pending operations, 
+  flushes all data to data files, and closes all data files. 
+---
+title: "Restart with the latest |oldversion| ``mongod`` instance."
+level: 4
+ref: 4.4-downgrade-restart-instance
+content: |
 
-  b. Replace the |newversion| binary with the downloaded |oldversion|
-     :binary:`~bin.mongod` binary and restart.
+  Replace the |newversion| binary with the downloaded |oldversion|
+  :binary:`~bin.mongod` binary and restart.
   
-...
+...

source/includes/steps-4.4-downgrade-replica-set.yaml

@@ -17,13 +17,9 @@ content: |
   Downgrade each :term:`secondary` member of the replica set, one at a
   time:
 
-  a. Shut down the :binary:`~bin.mongod`.
+  a. .. include:: /includes/4.4-downgrade-clean-shutdown.rst
 
-     .. code-block:: javascript
-
-        db.adminCommand( { shutdown: 1 } )
-
-  #. Replace the |newversion| binary with the |oldversion| binary and        restart.
+  #. Replace the |newversion| binary with the |oldversion| binary and restart.
 
   #. Wait for the member to recover to ``SECONDARY`` state
      before downgrading the next secondary. To check the member's state,
@@ -42,13 +38,7 @@ content: |
   Downgrade the :ref:`arbiter <replica-set-arbiter-configuration>` member of
   the replica set:
 
-  a. Shut down the :binary:`~bin.mongod`. See
-     :ref:`terminate-mongod-processes` for additional ways to safely
-     terminate :binary:`~bin.mongod` processes.
-
-     .. code-block:: javascript
-
-        db.adminCommand( { shutdown: 1 } )
+  a. .. include:: /includes/4.4-downgrade-clean-shutdown.rst
 
   #. Delete the contents of the arbiter data directory. The 
      :setting:`storage.dbPath` configuration setting or 
@@ -87,13 +77,9 @@ content: |
    When :method:`rs.status()` shows that the primary has stepped down
    and another member has assumed ``PRIMARY`` state:
      
-   a. Shut down the previous primary.
-
-      .. code-block:: javascript
-
-         db.adminCommand( { shutdown: 1 } )
+   a. .. include:: /includes/4.4-downgrade-clean-shutdown.rst
 
    b. Replace the :binary:`~bin.mongod` binary with
       the |oldversion| binary and restart.
    
-...
+...

source/includes/steps-4.4-downgrade-sharded-cluster.yaml

@@ -56,11 +56,7 @@ content: |
    A. Downgrade the shard's :ref:`secondary <replica-set-secondary-members>`
       members one at a time:
 
-      a. Shut down the :binary:`~bin.mongod` instance.
-
-         .. code-block:: javascript
-
-            db.adminCommand( { shutdown: 1 } )
+      1. .. include:: /includes/4.4-downgrade-clean-shutdown.rst
 
       #. Replace the |newversion|
          binary with the |oldversion| binary and restart.
@@ -76,13 +72,7 @@ content: |
 
       Skip this step if the replica set does not include an arbiter.
 
-      a. Shut down the :binary:`~bin.mongod`. See
-         :ref:`terminate-mongod-processes` for additional ways to safely
-         terminate :binary:`~bin.mongod` processes.
-
-         .. code-block:: javascript
-
-            db.adminCommand( { shutdown: 1 } )
+      1. .. include:: /includes/4.4-downgrade-clean-shutdown.rst
 
       #. Delete the contents of the arbiter data directory. The 
          :setting:`storage.dbPath` configuration setting or 
@@ -101,7 +91,7 @@ content: |
 
    #. Downgrade the shard's primary.
 
-      a. Step down the replica set primary. Connect a
+      1. Step down the replica set primary. Connect a
          :binary:`~bin.mongo` shell to the primary and use
          :method:`rs.stepDown()` to step down the primary and force an
          election of a new primary:
@@ -119,7 +109,10 @@ content: |
          When the status shows that the primary has stepped down and
          another member has assumed ``PRIMARY`` state, proceed.
 
-      #. Shut down the stepped-down primary.
+      #. Run the following command from the :binary:`~bin.mongo` shell to 
+         perform a clean shutdown of the stepped-down primary, or refer to 
+         :ref:`terminate-mongod-processes` for additional ways to safely  
+         terminate the :binary:`~bin.mongod` process:
 
          .. code-block:: javascript
 
@@ -138,11 +131,7 @@ content: |-
    A. Downgrade the :ref:`secondary <replica-set-secondary-members>`
       members of the config servers replica set (CSRS) one at a time:
 
-      a. Shut down the :binary:`~bin.mongod` instance.
-
-         .. code-block:: javascript
-
-            db.adminCommand( { shutdown: 1 } )
+      1. .. include:: /includes/4.4-downgrade-clean-shutdown.rst
 
       #. Replace the |newversion|
          binary with the |oldversion| binary and restart.
@@ -157,7 +146,7 @@ content: |-
 
    #. Step down the config server primary.
 
-      a. Connect a :binary:`~bin.mongo` shell to the primary and use
+      1. Connect a :binary:`~bin.mongo` shell to the primary and use
          :method:`rs.stepDown()` to step down the primary and force an
          election of a new primary:
 
@@ -174,7 +163,10 @@ content: |-
          When the status shows that the primary has stepped down and
          another member has assumed ``PRIMARY`` state, proceed.
             
-      #. Shut down the stepped-down primary.
+      #. Run the following command from the :binary:`~bin.mongo` shell to 
+         perform a clean shutdown of the stepped-down primary, or refer to 
+         :ref:`terminate-mongod-processes` for additional ways to safely  
+         terminate the :binary:`~bin.mongod` process:
 
          .. code-block:: javascript
 
@@ -201,4 +193,4 @@ content: |
   The :binary:`~bin.mongo` shell method :method:`sh.startBalancer()`
   also enables auto-splitting for the sharded cluster.
 
-...
+...