(DOCSP-23020): sync states reference page (#26)

* WIP

* (DOCSP-23020): sync states reference page

* add widths

* add bullets

* wording

* change ref location

* change terminology to mongosync

* change wording

Author: jeff-allen-mongo

source/includes/api/tables/progress-response.rst

@@ -9,7 +9,8 @@
 
    * - ``state``
      - string
-     - The current state of {+c2c-product-name+}.
+     - The current state of ``mongosync``. For information on the
+       possible states, see :ref:`c2c-states-descriptions`.
 
    * - ``canCommit``
      - boolean

source/reference.txt

@@ -9,3 +9,4 @@ Reference
 
    /reference/mongosync
    /reference/api
+   /reference/mongosync-states

source/reference/mongosync-states.txt

@@ -0,0 +1,74 @@
+.. _c2c-states:
+
+====================
+``mongosync`` States
+====================
+
+.. default-domain:: mongodb
+
+.. contents:: On this page
+   :local:
+   :backlinks: none
+   :depth: 2
+   :class: singlecol
+
+
+``mongosync`` enters different states depending on the requests it
+receives. This page describes the states that ``mongosync`` can be in.
+``mongosync`` is in a single state at a particular time. The possible
+API operations you can run depend on the state of ``mongosync``.
+
+View the Current State
+----------------------
+
+To view the current state of ``mongosync``, use the
+:ref:`/progress <c2c-api-progress>`. endpoint. The endpoint returns the
+state in the ``state`` field.
+
+.. _c2c-states-descriptions:
+
+State Descriptions
+------------------
+
+The following table describes each state and the operations you can run
+when ``mongosync`` is in a given state.
+
+.. list-table::
+   :header-rows: 1
+   :widths: 10 30 20
+
+   * - State
+     - Description
+     - Possible API Operations
+
+   * - ``IDLE``
+     - ``mongosync`` is initialized and ready for a sync job to
+       begin.
+     - - ``POST`` :ref:`/start <c2c-api-start>`
+       - ``GET`` :ref:`/progress <c2c-api-progress>`
+
+   * - ``RUNNING``
+     - The sync process is currently running. In this state, data is
+       initially synced to the destination cluster, and subsequent
+       writes are applied.
+     - - ``POST`` :ref:`/pause <c2c-api-pause>`
+       - ``POST`` :ref:`/commit <c2c-api-commit>`
+       - ``GET`` :ref:`/progress <c2c-api-progress>`
+
+   * - ``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>`
+       - ``GET`` :ref:`/progress <c2c-api-progress>`
+
+   * - ``COMMITTING``
+     - The cutover for the sync process has started. The time it takes
+       to transition to the ``COMMITTED`` phase depends on
+       ``lagTimeSeconds``. To monitor ``lagTimeSeconds`` or see if
+       ``mongosync`` has finished committing, use the
+       :ref:`/progress <c2c-api-progress>` endpoint.
+     - - ``GET`` :ref:`/progress <c2c-api-progress>`
+
+   * - ``COMMITTED``
+     - The cutover for the sync process is complete.
+     - - ``GET`` :ref:`/progress <c2c-api-progress>`