DOCSP-24514 Adds interlinks for replication methods (#2525)

kennethdyer · web-flow · commit b9e5c121ee47 · 2023-02-08T10:19:31.000-05:00
* DOCSP-24514 Adds interlinks for replication methods * Fixes per Sarah Olson * Fixes per Sarah Olson
diff --git a/source/reference/command/replSetFreeze.txt b/source/reference/command/replSetFreeze.txt
@@ -21,6 +21,10 @@ Definition
    :dbcommand:`replSetStepDown` command to make a different node in
    the replica set a primary.
 
+   .. |method| replace:: :method:`rs.freeze` helper method
+   .. include:: /includes/fact-dbcommand-tip
+
+
 Syntax
 ------
 
diff --git a/source/reference/command/replSetGetConfig.txt b/source/reference/command/replSetGetConfig.txt
@@ -18,6 +18,9 @@ Definition
    Returns a document that describes the current :ref:`configuration
    <replica-set-configuration-document>` of the :term:`replica set`. 
 
+   .. |method| replace:: :method:`rs.conf` helper method
+   .. include:: /includes/fact-dbcommand-tip
+
 Syntax
 ------
 
diff --git a/source/reference/command/replSetGetStatus.txt b/source/reference/command/replSetGetStatus.txt
@@ -27,6 +27,10 @@ Definition
    Because of the frequency of heartbeats, these data can be several
    seconds out of date.
 
+   .. |method| replace:: :method:`rs.status` helper method
+   .. include:: /includes/fact-dbcommand-tip
+
+
 Syntax
 ------
 
diff --git a/source/reference/command/replSetInitiate.txt b/source/reference/command/replSetInitiate.txt
@@ -19,6 +19,9 @@ Definition
    
    .. |command| replace:: ``replSetInitiate``
 
+   .. |method| replace:: :method:`rs.initiate` helper method
+   .. include:: /includes/fact-dbcommand-tip
+
    .. include:: /includes/fact-dbcommand.rst
 
    .. note::
diff --git a/source/reference/command/replSetReconfig.txt b/source/reference/command/replSetReconfig.txt
@@ -21,6 +21,10 @@ Definition
    members. You must run this command on the ``admin``
    database of the :term:`primary` replica set member.
 
+   .. |method| replace:: :method:`rs.reconfig` helper method
+   .. include:: /includes/fact-dbcommand-tip
+
+
 Syntax
 ------
 
diff --git a/source/reference/command/replSetStepDown.txt b/source/reference/command/replSetStepDown.txt
@@ -21,6 +21,9 @@ Description
 
    .. include:: /includes/stepdown-intro.rst
 
+   .. |method| replace:: :method:`rs.stepDown` helper method
+   .. include:: /includes/fact-dbcommand-tip
+
    The :dbcommand:`replSetStepDown` can only run on the ``admin`` database.
 
 Syntax
diff --git a/source/reference/command/replSetSyncFrom.txt b/source/reference/command/replSetSyncFrom.txt
@@ -20,7 +20,8 @@ Description
    patterns and in situations where a set member is not replicating
    from the desired host.
 
-   .. include:: /includes/fact-voting-node-sync-incompatibility.rst
+   .. |method| replace:: :method:`rs.syncFrom` helper method
+   .. include:: /includes/fact-dbcommand-tip
 
    Run :dbcommand:`replSetSyncFrom` in the ``admin`` database.
 
diff --git a/source/reference/method/rs.conf.txt b/source/reference/method/rs.conf.txt
@@ -18,7 +18,8 @@ Definition
    Returns a document that contains the current :term:`replica set`
    configuration.
 
-   The method wraps the :dbcommand:`replSetGetConfig` command.
+   .. |dbcommand| replace:: :dbcommand:`replSetGetConfig` command
+   .. include:: /includes/fact-mongosh-shell-method-alt
 
    .. include:: /includes/extracts/4.4-replSetGetConfiguration-commitmentStatus.rst
    
diff --git a/source/reference/method/rs.freeze.txt b/source/reference/method/rs.freeze.txt
@@ -18,6 +18,9 @@ Description
    Makes the current :term:`replica set` member ineligible to become
    :term:`primary` for the period specified.
 
+   .. |dbcommand| replace:: :dbcommand:`replSetFreeze` command
+   .. include:: /includes/fact-mongosh-shell-method-alt
+
    The :method:`rs.freeze()` method has the following parameter:
 
 
@@ -37,9 +40,3 @@ Description
    
         - The duration the member is ineligible to become primary.
           
-          
-   
-
-
-   :method:`rs.freeze()` provides a wrapper around the :term:`database
-   command` :dbcommand:`replSetFreeze`.
diff --git a/source/reference/method/rs.initiate.txt b/source/reference/method/rs.initiate.txt
@@ -20,6 +20,9 @@ Description
    :ref:`configuration of a replica set
    <replica-set-configuration-document>`.
 
+   .. |dbcommand| replace:: :dbcommand:`replSetInitiate` command
+   .. include:: /includes/fact-mongosh-shell-method-alt
+
    The :method:`rs.initiate()` method has the following parameter:
 
 
@@ -38,9 +41,6 @@ Description
           configuration is not specified, MongoDB uses a default 
           replica set configuration.
 
-   The :method:`rs.initiate()` method provides a wrapper around the
-   :dbcommand:`replSetInitiate` command.
-
 IP Binding
 ----------
 
diff --git a/source/reference/method/rs.reconfig.txt b/source/reference/method/rs.reconfig.txt
@@ -19,6 +19,9 @@ Definition
    replica set configuration. To run the method, you must connect to
    the :term:`primary` of the replica set.
 
+   .. |dbcommand| replace:: :dbcommand:`replSetReconfig` command
+   .. include:: /includes/fact-mongosh-shell-method-alt
+
    The :method:`rs.reconfig()` method has the following syntax:
 
    .. code-block:: bash
@@ -86,9 +89,6 @@ Definition
    current configuration with :method:`rs.conf()`, modify the
    configuration document as needed, and then pass the modified
    document to :method:`rs.reconfig()`.
-
-   :method:`rs.reconfig()` provides a wrapper around the
-   :dbcommand:`replSetReconfig` command.
    
    The ``force`` parameter allows a reconfiguration command to be issued
    to a non-primary node.
diff --git a/source/reference/method/rs.status.txt b/source/reference/method/rs.status.txt
@@ -16,8 +16,10 @@ Definition
 .. method:: rs.status()
 
    Returns the replica set status from the point of view of the member
-   where the method is run. This method provides a wrapper around the
-   :dbcommand:`replSetGetStatus` command.
+   where the method is run. 
+
+   .. |dbcommand| replace:: :dbcommand:`replSetGetStatus` command
+   .. include:: /includes/fact-mongosh-shell-method-alt
 
    This output reflects the current status of the replica set, using
    data derived from the heartbeat packets sent by the other members
diff --git a/source/reference/method/rs.stepDown.txt b/source/reference/method/rs.stepDown.txt
@@ -20,6 +20,9 @@ Description
    .. |behavior-ref| replace:: :ref:`rs.stepDown-behavior`
 
    .. include:: /includes/stepdown-intro.rst
+
+   .. |dbcommand| replace:: :dbcommand:`replSetStepDown` command
+   .. include:: /includes/fact-mongosh-shell-method-alt
    
    The :method:`rs.stepDown()` method has the following parameters:
 
@@ -62,8 +65,6 @@ Description
    
 
 
-   :method:`rs.stepDown()` provides a wrapper around the
-   command :dbcommand:`replSetStepDown`.
 
 .. _rs.stepDown-behavior:
 
diff --git a/source/reference/method/rs.syncFrom.txt b/source/reference/method/rs.syncFrom.txt
@@ -12,12 +12,14 @@ rs.syncFrom()
 
 .. method:: rs.syncFrom()
 
-   Provides a wrapper around the :dbcommand:`replSetSyncFrom`, which
-   allows administrators to temporarily override the default sync
-   target for the current member. Specify the name of the member you
+   Temporarily overrides the default sync target for the current member. 
+
+   .. |dbcommand| replace:: :dbcommand:`replSetFreeze` command
+   .. include:: /includes/fact-mongosh-shell-method-alt
+
+   Specify the name of the member you
    want to replicate from in the form of ``[hostname]:[port]``.
 
-   .. include:: /includes/fact-voting-node-sync-incompatibility.rst
 
 Behavior
 --------
