DOCSP-32941-resharding-update (#5254) (#5289)

* DOCSP-32941-resharding-update

* DOCSP-32941-resharding-update

---------

Co-authored-by: jason-price-mongodb <[email protected]>

Author: jason-price-mongodb

source/core/sharding-reshard-a-collection.txt

@@ -30,7 +30,7 @@ across a cluster.
 .. _reshard-requirements:
 
 Requirements
---------------
+------------
 
 Before you reshard your collection, ensure that you meet the following
 requirements:
@@ -105,6 +105,7 @@ requirements:
   check for any running index builds:
 
   .. code-block:: javascript
+     :copyable: false
 
      db.adminCommand(
         {
@@ -120,6 +121,7 @@ requirements:
   array, there are no index builds in progress:
 
   .. code-block:: javascript
+     :copyable: false
 
      {
         inprog: [],

source/reference/method/sh.reshardCollection.txt

@@ -20,32 +20,30 @@ Definition
    The :method:`sh.reshardCollection()` method changes the shard key for
    a collection and changes the distribution of your data.
 
+   Before you reshard a collection, read the the :ref:`reshard
+   requirements <reshard-requirements>` and :ref:`reshard limitations
+   <resharding-limitations>`.
+
    .. |dbcommand| replace:: :dbcommand:`reshardCollection` command
    .. include:: /includes/fact-mongosh-shell-method-alt.rst
 
-   :method:`sh.reshardCollection()` takes the following arguments:
+   ``sh.reshardCollection()`` takes the following fields:
 
    .. list-table::
       :header-rows: 1
       :widths: 20 20 80
 
-      * - Parameter
-
+      * - Field
         - Type
-
         - Description
 
       * - ``namespace``
-
         - string
-
         - The :term:`namespace` of the collection to shard in the form
           ``"<database>.<collection>"``.
 
       * - ``key``
-
         - document
-
         - The document that specifies the new field or fields to use as the
           :ref:`shard key <sharding-shard-key>`.
 
@@ -54,44 +52,34 @@ Definition
           Set the field values to either:
 
           - ``1`` for :doc:`ranged based sharding </core/ranged-sharding>`
-
           - ``"hashed"`` to specify a
             :ref:`hashed shard key <hashed-shard-keys>`.
 
           See also :ref:`sharding-shard-key-indexes`
 
       * - ``unique``
-
         - boolean
-
         - Optional. Specify whether there is a :doc:`uniqueness
           </core/index-unique>` constraint on the shard key. Only
           ``false`` is supported. Defaults to ``false``.
 
       * - ``options``
-
         - document
-
         - Optional. A document containing optional fields, including
           ``numInitialChunks``, ``collation`` and ``zones``.
 
-
-The ``options`` argument supports the following options:
+The ``options`` field supports the following fields:
 
 .. list-table::
    :header-rows: 1
    :widths: 20 20 80
 
-   * - Parameter
-
+   * - Field
      - Type
-
      - Description
 
    * - ``numInitialChunks``
-
      - integer
-
      - Optional. Specifies the initial number of chunks to create
        across all shards in the cluster when resharding a collection.
        The default is the number of chunks that exist for the
@@ -100,22 +88,19 @@ The ``options`` argument supports the following options:
        ``numInitialChunks`` must result in less than ``8192`` per shard.
 
    * - ``collation``
-
      - document
-
      - Optional. If the collection specified to ``reshardCollection``
        has a default :ref:`collation <collation>`, you *must* include a 
        collation document with ``{ locale : "simple" }``, or the 
        ``reshardCollection`` command fails.
 
    * - ``zones``
-
      - array
-
      - Optional. To maintain or add :ref:`zones <zone-sharding>`,
        specify the zones for your collection in an array:
 
        .. code-block:: javascript
+          :copyable: false
 
           [
              {
@@ -168,7 +153,7 @@ During the clone, apply, and catch-up phase:
 
   .. note::
 
-     If desired, you can manually force the resharding operation to
+     If required, you can manually force the resharding operation to
      complete by issuing the :method:`sh.commitReshardCollection()`
      method. This is useful if the current time estimate to complete the
      resharding operation is an acceptable duration for your collection
@@ -182,8 +167,8 @@ During the clone, apply, and catch-up phase:
 Commit Phase
 ~~~~~~~~~~~~
 
-- Once the resharding process reaches the commit phase, it may no longer
-  be aborted with :method:`sh.abortReshardCollection()`.
+- After the resharding process reaches the commit phase, the process
+  cannot be ended with :method:`sh.abortReshardCollection()`.
 - When all shards have reached strict consistency, the resharding
   coordinator commits the resharding operation and installs the new
   routing table.
@@ -207,11 +192,12 @@ new shard key ``{ order_id: 1 }``:
 
 .. code-block:: javascript
 
-   sh.reshardCollection("sales.orders", { order_id: 1 })
+   sh.reshardCollection( "sales.orders", { order_id: 1 } )
 
-MongoDB returns the following:
+Example output:
 
 .. code-block:: javascript
+   :copyable: false
 
    {
      ok: 1,