DOCSP-33889 Various C2C Improvements (#171) (#269)

* DOCSP-33889 Various improvements to C2C Docs

* Various improvements

* Various improvements

* Various improvements

* Various improvements

* Fixes build warning

* Fixes build warning

* Fixes build warning

* Fixes build warning

* Fixes per Jeff

* Fixes typo

Author: kennethdyer

source/includes/collections/behavior-capped-collections.rst

@@ -14,4 +14,4 @@ during sync:
 - The maximum collection size is 1PB.
 
 ``mongosync`` restores the original values for maximum number of
-documents and maximum document size during commit.
+documents and maximum document size during commit.

source/quickstart.txt

@@ -170,10 +170,10 @@ Follow the instructions below to set up {+c2c-product-name+}.
 Initialize ``mongosync``
 ------------------------
 
-``mongosync`` must create an initial connection to the source and
-destination clusters before it can start to sync data. To create the
-initial connection, issue the following command on a single line (the
-command is reformated here for clarity):
+:program:`mongosync` must create an initial connection to the source and
+destination clusters before it can start to sync data. To create the initial
+connection, issue the following command on a single line (the command is
+reformatted here for clarity):
 
 .. code-block:: shell
 
@@ -287,15 +287,9 @@ Synchronization Notes
   <c2c-mongosync>`
 
 - ``mongosync`` can swap the source and destination clusters to enable
-  :ref:`reverse synchronization <c2c-api-reverse>`. To use ``reverse
-  synchronization``, you must pass these additional fields when you
-  start ``mongosync``:
-
-  - ``reverse``
-  - ``enableUserWriteBlocking``
-
-  .. literalinclude:: /includes/api/requests/reverse.sh
-     :language: shell
+  :ref:`reverse synchronization <c2c-api-reverse>`.  
+  
+  For more information, see the :ref:`c2c-api-reverse` endpoint.
 
 - .. include:: /includes/fact-permissions-body.rst
 

source/reference/api/pause.txt

@@ -21,8 +21,8 @@ Pauses the current synchronization operation.
 Requirement
 -----------
 
-To use the ``pause`` endpoint, ``mongosync`` must be in the ``RUNNING``
-state.
+To use the ``pause`` endpoint, ``mongosync`` must be in the :ref:`RUNNING
+<c2c-state-running>` state.
 
 .. note::
 

source/reference/api/progress.txt

@@ -15,7 +15,7 @@
 Description
 -----------
 
-Returns the status of the synchronization process.
+Returns either an updated status of the synchronization process or an error.
 
 Request
 -------

source/reference/api/resume.txt

@@ -22,8 +22,8 @@ destination cluster.
 Requirement
 -----------
 
-To use the ``resume`` endpoint, ``mongosync`` must be in the ``PAUSED``
-state.
+To use the ``resume`` endpoint, ``mongosync`` must be in the :ref:`PAUSED
+<c2c-state-paused>` state.
 
 .. note::
 

source/reference/api/reverse.txt

@@ -43,7 +43,6 @@ To use the ``reverse`` endpoint:
 
   You cannot update these options after the sync starts.
 - ``mongosync`` must be in the ``COMMITTED`` state.
-- Source and destination clusters must be MongoDB 6.0 or later.
 - :ref:`index-type-unique` require proper formatting.  Collections with indexes
   initially created on MongoDB 4.2 may not have the proper formatting. 
 

source/reference/api/start.txt

@@ -464,9 +464,8 @@ Indexes that are always built include:
 * ``mongosync`` builds an index on the ``_id`` field of every
   collection it copies.
 
-* Starting in MongoDB 6.0, ``mongosync`` builds dummy indexes that support 
-  the shard key for each sharded collection, which are removed after commit.
-  When ``buildIndexes`` is set to ``never``, ``mongosync`` retains this
-  index after commit.
+* ``mongosync`` builds dummy indexes that support the shard key for each
+  sharded collection, which are removed after commit. When ``buildIndexes`` is
+  set to ``never``, ``mongosync`` retains this index after commit.
 
 

source/reference/mongosync-states.txt

@@ -50,15 +50,19 @@ operations in that state.
      - - ``POST`` :ref:`/start <c2c-api-start>`
        - ``GET`` :ref:`/progress <c2c-api-progress>`
 
-   * - ``RUNNING``
+   * - .. _c2c-state-running:
+
+       ``RUNNING``
      - The sync process is currently running. In this state, data is
        initially synced to the destination cluster. Subsequent writes to
        the source cluster are applied to the destination cluster.
      - - ``POST`` :ref:`/pause <c2c-api-pause>`
        - ``POST`` :ref:`/commit <c2c-api-commit>`
        - ``GET`` :ref:`/progress <c2c-api-progress>`
 
-   * - ``PAUSED``
+   * - .. _c2c-state-paused:
+
+       ``PAUSED``
      - The sync process is paused. To resume the sync process, send a
        request to the :ref:`/resume <c2c-api-resume>` endpoint.
      - - ``POST`` :ref:`/resume <c2c-api-resume>`
@@ -74,7 +78,10 @@ operations in that state.
        <c2c-api-progress>` endpoint.
      - - ``GET`` :ref:`/progress <c2c-api-progress>`
 
-   * - ``COMMITTED``
+   * - .. _c2c-state-committed:
+
+       ``COMMITTED``
      - The cutover for the sync process is complete.
      - - ``GET`` :ref:`/progress <c2c-api-progress>`
        - ``GET`` :ref:`/reverse <c2c-api-reverse>`
+

source/release-notes/1.5.txt

@@ -20,13 +20,13 @@ Release Notes for mongosync 1.5
 
 **July 25, 2023**
 
-Oplog Rollover Resiliency
+Oplog Rollover Resilience
 ~~~~~~~~~~~~~~~~~~~~~~~~~
 
 Starting in 1.5.0, ``mongosync`` begins to apply changes while the
 initial sync is still in progress. By starting to apply changes earlier,
 ``mongosync`` maintains a more recent position in the :term:`oplog`.
-This adds resiliency to long-running operations, mitigates the risk
+This adds resilience to long-running operations, mitigates the risk
 of ``oplog`` rollover, and significantly lowers the risk of restarting
 the sync.