DOCSP-24515 sharding interlink v4.4 (#2489)

kennethdyer · web-flow · commit df2ded39dc09 · 2023-02-02T12:47:21.000-05:00
* DOCSP-24515 Adds Interlinks for Sharding Methods (#2473) (#2483) * DOCSP-24515 Interlinks for Sharding Methods/Commands * Fixes typo * addShard * addShard * Interlinks addShardToZone * interlinks balancerCollectionStatus * Adds interlinks * Fixes TOC order * Adds interlinks * Fixes build error
diff --git a/source/reference/command/addShard.txt b/source/reference/command/addShard.txt
@@ -17,6 +17,9 @@ Definition
 
    Adds a shard replica set to a :term:`sharded cluster`.
 
+   .. |method| replace:: :method:`sh.addShard` helper method
+   .. include:: /includes/fact-dbcommand-tip
+
    Run :dbcommand:`addShard` when connected to a :binary:`~bin.mongos`
    instance. The command takes the following form to add a shard
    replica set:
diff --git a/source/reference/command/addShardToZone.txt b/source/reference/command/addShardToZone.txt
@@ -21,6 +21,9 @@ Definition
    the given zone. Chunks that are covered by the zone are assigned to shards
    associated with the zone.
 
+   .. |method| replace:: :method:`sh.addShardToZone` helper method
+   .. include:: /includes/fact-dbcommand-tip
+
    .. |command| replace:: ``addShardToZone``
 
 Syntax
diff --git a/source/reference/command/balancerCollectionStatus.txt b/source/reference/command/balancerCollectionStatus.txt
@@ -26,6 +26,10 @@ Definition
    You can only issue the :dbcommand:`balancerCollectionStatus` against the
    ``admin`` database.
 
+   .. |method| replace:: :method:`sh.balancerCollectionStatus`
+      helper method
+   .. include:: /includes/fact-dbcommand-tip
+
    The command takes the following form:
 
    .. code-block:: javascript
diff --git a/source/reference/command/balancerStart.txt b/source/reference/command/balancerStart.txt
@@ -24,6 +24,10 @@ Definition
    sharded cluster. To disable auto-splitting when the balancer is
    enabled, you can use :method:`sh.disableAutoSplit()`.
    
+   .. |method| replace:: :method:`sh.startBalancer` 
+      helper method
+   .. include:: /includes/fact-dbcommand-tip
+
 Syntax
 ------
 
@@ -87,4 +91,4 @@ and issue the following command:
 .. seealso::
 
    - :method:`sh.startBalancer()`
-   - :dbcommand:`balancerStart`
+   - :dbcommand:`balancerStart`
diff --git a/source/reference/command/balancerStatus.txt b/source/reference/command/balancerStatus.txt
@@ -23,6 +23,10 @@ Definition
    You can only issue the :dbcommand:`balancerStatus` against the
    ``admin`` database.
 
+   .. |method| replace:: :method:`sh.isBalancerRunning` 
+      helper method
+   .. include:: /includes/fact-dbcommand-tip
+
    The command takes the following form:
 
    .. code-block:: javascript
diff --git a/source/reference/command/balancerStop.txt b/source/reference/command/balancerStop.txt
@@ -23,6 +23,14 @@ Definition
    Starting in MongoDB 4.2, the command disables auto-splitting for the sharded cluster. To enable auto-splitting when the balancer is
    disabled, you can use :method:`sh.enableAutoSplit()`.
 
+   You can only issue the :dbcommand:`balancerStop` against the
+   ``admin`` database on a :binary:`~bin.mongos` instance.
+
+
+   .. |method| replace:: :method:`sh.stopBalancer` 
+      helper method
+   .. include:: /includes/fact-dbcommand-tip
+
 Syntax
 ------
 
diff --git a/source/reference/command/enableSharding.txt b/source/reference/command/enableSharding.txt
@@ -20,9 +20,10 @@ Definition
    for a database, you can use the :dbcommand:`shardCollection` command
    to shard collections in that database.
 
-   The :binary:`~bin.mongo` shell method :method:`sh.enableSharding()`
-   wraps the :dbcommand:`enableSharding` command.
-  
+   .. |method| replace:: :method:`sh.enableSharding` 
+      helper method
+   .. include:: /includes/fact-dbcommand-tip
+
 Syntax
 ------
 
diff --git a/source/reference/command/moveChunk.txt b/source/reference/command/moveChunk.txt
@@ -20,6 +20,11 @@ Definition
    a :binary:`~bin.mongos` instance while using the :term:`admin database`.
    Use the following forms:
 
+
+   .. |method| replace:: :method:`sh.moveChunk` 
+      helper method
+   .. include:: /includes/fact-dbcommand-tip
+
    .. code-block:: javascript
 
 
diff --git a/source/reference/command/removeShardFromZone.txt b/source/reference/command/removeShardFromZone.txt
@@ -20,6 +20,11 @@ Definition
    The :dbcommand:`removeShardFromZone` administrative command removes the
    association between a shard and a :term:`zone`.
 
+
+   .. |method| replace:: :method:`sh.removeShardFromZone` 
+      helper method
+   .. include:: /includes/fact-dbcommand-tip
+
    .. |command| replace:: ``removeShardFromZone``
 
 Syntax
diff --git a/source/reference/command/shardCollection.txt b/source/reference/command/shardCollection.txt
@@ -25,6 +25,10 @@ Definition
 
    .. include:: /includes/fact-dbcommand.rst
 
+   .. |method| replace:: :method:`sh.shardCollection` 
+      helper method
+   .. include:: /includes/fact-dbcommand-tip
+
    :dbcommand:`shardCollection` has the following form:
 
    .. code-block:: javascript
diff --git a/source/reference/command/split.txt b/source/reference/command/split.txt
@@ -27,6 +27,10 @@ Definition
    these circumstances, and on the MongoDB shell commands that wrap
    :dbcommand:`split`.
 
+   .. |method| replace:: :method:`sh.splitAt` and :method:`sh.splitFind`
+      helper methods
+   .. include:: /includes/fact-dbcommand-tip
+
    The :dbcommand:`split` command must be run in the ``admin`` database
    and uses the following form:
 
diff --git a/source/reference/command/updateZoneKeyRange.txt b/source/reference/command/updateZoneKeyRange.txt
@@ -23,6 +23,11 @@ Definition
 
    .. include:: /includes/extracts/zoned-sharding-updateZoneKeyRange-change.rst
 
+   .. |method| replace:: :method:`sh.updateZoneKeyRange` 
+      helper method
+   .. include:: /includes/fact-dbcommand-tip
+
+
    .. |command| replace:: ``updateZoneKeyRange``
 
    .. include:: /includes/fact-dbcommand.rst
diff --git a/source/reference/method/js-sharding.txt b/source/reference/method/js-sharding.txt
@@ -148,6 +148,7 @@ Sharding Methods
    :titlesonly: 
    :hidden: 
 
+   /reference/method/convertShardKeyToHashed
    /reference/method/sh.addShard
    /reference/method/sh.addShardTag
    /reference/method/sh.addShardToZone
@@ -159,13 +160,13 @@ Sharding Methods
    /reference/method/sh.enableAutoSplit
    /reference/method/sh.enableSharding
    /reference/method/sh.getBalancerState
-   /reference/method/sh.removeTagRange
-   /reference/method/sh.removeRangeFromZone
    /reference/method/sh.help
    /reference/method/sh.isBalancerRunning
    /reference/method/sh.moveChunk
+   /reference/method/sh.removeRangeFromZone
    /reference/method/sh.removeShardTag
    /reference/method/sh.removeShardFromZone
+   /reference/method/sh.removeTagRange
    /reference/method/sh.setBalancerState
    /reference/method/sh.shardCollection
    /reference/method/sh.splitAt
@@ -177,4 +178,3 @@ Sharding Methods
    /reference/method/sh.waitForBalancerOff
    /reference/method/sh.waitForPingChange
    /reference/method/sh.updateZoneKeyRange
-   /reference/method/convertShardKeyToHashed
diff --git a/source/reference/method/sh.addShard.txt b/source/reference/method/sh.addShard.txt
@@ -18,6 +18,9 @@ Definition
    Adds a shard replica set to a :term:`sharded cluster`. This method
    must be run on a :binary:`~bin.mongos` instance.
 
+   .. |dbcommand| replace:: :dbcommand:`addShard` command
+   .. include:: /includes/fact-mongo-shell-method-alt.rst
+
    The :method:`sh.addShard()` method has the following parameter:
 
 
@@ -63,10 +66,6 @@ Definition
       .. include:: /includes/note-deb-and-rpm-default-to-localhost.rst
 
    .. include:: /includes/extracts/mongos-operations-wc-add-shard.rst
-   
-   The :method:`sh.addShard()` method is a helper for the
-   :dbcommand:`addShard` command. The :dbcommand:`addShard` command has
-   additional options which are not available with this helper.
 
 Considerations
 --------------
diff --git a/source/reference/method/sh.addShardToZone.txt b/source/reference/method/sh.addShardToZone.txt
@@ -21,6 +21,10 @@ Definition
       with the given zone. Chunks that are covered by the zone are assigned to
       shards associated with the zone.
 
+   .. |dbcommand| replace:: :dbcommand:`addShardToZone` command
+   .. include:: /includes/fact-mongo-shell-method-alt.rst
+
+   This method has the following parameter:
 
    .. list-table::
       :header-rows: 1
diff --git a/source/reference/method/sh.balancerCollectionStatus.txt b/source/reference/method/sh.balancerCollectionStatus.txt
@@ -23,9 +23,8 @@ Definition
    of draining shards, zone violation or imbalance of chunks across
    shards. 
    
-   The :binary:`~bin.mongo` shell method
-   :method:`sh.balancerCollectionStatus()` wraps the
-   :dbcommand:`balancerCollectionStatus` command.
+   .. |dbcommand| replace:: :dbcommand:`balancerCollectionStatus` command
+   .. include:: /includes/fact-mongo-shell-method-alt.rst
 
 Syntax
 ------
diff --git a/source/reference/method/sh.enableSharding.txt b/source/reference/method/sh.enableSharding.txt
@@ -21,6 +21,10 @@ Definition
    shell method :method:`sh.enableSharding()` wraps the
    :dbcommand:`enableSharding` command.
 
+   .. |dbcommand| replace:: :dbcommand:`enableSharding` command
+   .. include:: /includes/fact-mongo-shell-method-alt.rst
+
+
 Syntax
 ------
 
diff --git a/source/reference/method/sh.isBalancerRunning.txt b/source/reference/method/sh.isBalancerRunning.txt
@@ -19,6 +19,9 @@ sh.isBalancerRunning()
    running. Use :method:`sh.getBalancerState()` to determine if the
    balancer is enabled or disabled.
 
+   .. |dbcommand| replace:: :dbcommand:`balancerStatus` command
+   .. include:: /includes/fact-mongo-shell-method-alt.rst
+
 .. seealso::
 
    - :method:`sh.enableBalancing()`
diff --git a/source/reference/method/sh.moveChunk.txt b/source/reference/method/sh.moveChunk.txt
@@ -25,6 +25,9 @@ Definition
       automatically migrate :term:`chunks <chunk>`, and avoid calling
       :method:`sh.moveChunk()` directly.
 
+   .. |dbcommand| replace:: :dbcommand:`moveChunk` command
+   .. include:: /includes/fact-mongo-shell-method-alt.rst
+
    :method:`sh.moveChunk()` takes the following arguments:
     
    .. list-table::
diff --git a/source/reference/method/sh.removeShardFromZone.txt b/source/reference/method/sh.removeShardFromZone.txt
@@ -19,6 +19,10 @@ Definition
 
    Removes the association between a :term:`zone` and a shard.
 
+   .. |dbcommand| replace:: :dbcommand:`removeShardFromZone` command
+   .. include:: /includes/fact-mongo-shell-method-alt.rst
+
+   This method has the following parameters:
 
    .. list-table::
       :header-rows: 1
diff --git a/source/reference/method/sh.setBalancerState.txt b/source/reference/method/sh.setBalancerState.txt
@@ -23,6 +23,11 @@ Description
    currently enabled or disabled and :method:`sh.isBalancerRunning()`
    to check its current state.
 
+   .. |dbcommand| replace:: :dbcommand:`balancerStart` and
+      :dbcommand:`balancerStop` commands
+   .. include:: /includes/fact-mongo-shell-method-alt.rst
+
+
    .. important::
 
       You can only run :method:`sh.setBalancerState()` on a
diff --git a/source/reference/method/sh.shardCollection.txt b/source/reference/method/sh.shardCollection.txt
@@ -24,6 +24,9 @@ Definition
    The :binary:`~bin.mongo` shell method :method:`sh.shardCollection`
    wraps the :dbcommand:`shardCollection` command.
 
+   .. |dbcommand| replace:: :dbcommand:`shardCollection` command
+   .. include:: /includes/fact-mongo-shell-method-alt.rst
+
    :method:`sh.shardCollection()` takes the following
    arguments:
 
diff --git a/source/reference/method/sh.splitAt.txt b/source/reference/method/sh.splitAt.txt
@@ -17,6 +17,10 @@ Definition
 
    Splits a chunk at the shard key value specified by the query.
 
+   .. |dbcommand| replace:: :dbcommand:`split` command
+   .. include:: /includes/fact-mongo-shell-method-alt.rst
+
+
    The method takes the following arguments:
 
 
@@ -46,12 +50,7 @@ Definition
         - A query document that specifies the :term:`shard key` value at which
           to split the chunk.
           
-          
-   
-
 
-   The :method:`sh.splitAt()` method wraps the :dbcommand:`split`
-   command.
 
 Consideration
 -------------
diff --git a/source/reference/method/sh.splitFind.txt b/source/reference/method/sh.splitFind.txt
@@ -20,6 +20,9 @@ Definition
    creates two roughly equal chunks. To split a chunk at a specific
    point instead, see :method:`sh.splitAt()`.
 
+   .. |dbcommand| replace:: :dbcommand:`split` command
+   .. include:: /includes/fact-mongo-shell-method-alt.rst
+
    The method takes the following arguments:
 
 
diff --git a/source/reference/method/sh.startBalancer.txt b/source/reference/method/sh.startBalancer.txt
@@ -21,6 +21,9 @@ Definition
    :method:`sh.startBalancer()` also enables auto-splitting for the
    sharded cluster.
    
+   .. |dbcommand| replace:: :dbcommand:`balancerStart` command
+   .. include:: /includes/fact-mongo-shell-method-alt.rst
+
    The method can take the following options:
 
 
diff --git a/source/reference/method/sh.stopBalancer.txt b/source/reference/method/sh.stopBalancer.txt
@@ -21,6 +21,9 @@ Definition
    :method:`sh.stopBalancer()` also disables auto-splitting for the
    sharded cluster.
 
+   .. |dbcommand| replace:: :dbcommand:`balancerStop` command
+   .. include:: /includes/fact-mongo-shell-method-alt.rst
+
    The method can take the following options:
 
 
diff --git a/source/reference/method/sh.updateZoneKeyRange.txt b/source/reference/method/sh.updateZoneKeyRange.txt
@@ -21,6 +21,9 @@ Definition
 
    .. include:: /includes/extracts/zoned-sharding-updateZoneKeyRange-change.rst
 
+   .. |dbcommand| replace:: :dbcommand:`updateZoneKeyRange` command
+   .. include:: /includes/fact-mongo-shell-method-alt.rst
+
    :method:`sh.updateZoneKeyRange()` takes the following arguments:
 
 
