Update references

blink1073 · Dec 7, 2023 · f30793e · f30793e
1 parent 8c0b842
commit f30793e
Show file tree

Hide file tree

Showing 27 changed files with 40 additions and 40 deletions.
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
@@ -8,4 +8,3 @@ Please complete the following before merging:
 - [ ] Test these changes against all server versions and topologies (including standalone, replica set, sharded clusters, and serverless).
 
 <!-- See also: https://wiki.corp.mongodb.com/pages/viewpage.action?pageId=80806719 -->
-
diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml
@@ -35,5 +35,5 @@ jobs:
     steps:
       - uses: actions/checkout@v4
       - uses: actions/setup-python@v4
-      - run:  pip install sphinx
+      - run:  pip install sphinx myst-parser
       - run:  cd source && sphinx-build -W -b text . docs_build index.rst
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -28,6 +28,7 @@ repos:
     - id: mdformat
       additional_dependencies:
         [mdformat-gfm]
+      exclude: LICENSE.md
 
 - repo: https://github.com/tcort/markdown-link-check
   rev: v3.11.2

diff --git a/source/auth/auth.rst b/source/auth/auth.rst
@@ -182,7 +182,7 @@ SDAM's `Why mark a server Unknown after an auth error`_ for rationale.)
 
 All blocking operations executed as part of the authentication handshake MUST
 apply timeouts per the `Client Side Operations Timeout
-<../client-side-operations-timeout/client-side-operations-timeout.rst>`__
+<../client-side-operations-timeout/client-side-operations-timeout.md>`__
 specification.
 
 Mechanism Negotiation via Handshake

diff --git a/source/change-streams/change-streams.rst b/source/change-streams/change-streams.rst
@@ -836,7 +836,7 @@ All drivers MUST document how users can iterate a change stream and receive *all
 Timeouts
 ^^^^^^^^
 
-Drivers MUST apply timeouts to change stream establishment, iteration, and resume attempts per `Client Side Operations Timeout: Change Streams <../client-side-operations-timeout/client-side-operations-timeout.rst#Change-Streams>`__.
+Drivers MUST apply timeouts to change stream establishment, iteration, and resume attempts per `Client Side Operations Timeout: Change Streams <../client-side-operations-timeout/client-side-operations-timeout.md#Change-Streams>`__.
 
 Notes and Restrictions
 ^^^^^^^^^^^^^^^^^^^^^^

diff --git a/source/client-side-encryption/client-side-encryption.rst b/source/client-side-encryption/client-side-encryption.rst
@@ -1474,7 +1474,7 @@ management.
 
 Drivers MUST apply timeouts to operations executed as part of client-side encryption per `Client Side Operations
 Timeout: Client Side Encryption
-<../client-side-operations-timeout/client-side-operations-timeout.rst#client-side-encryption>`__.
+<../client-side-operations-timeout/client-side-operations-timeout.md#client-side-encryption>`__.
 
 Integrating with libmongocrypt
 ==============================

diff --git a/source/client-side-encryption/tests/README.rst b/source/client-side-encryption/tests/README.rst
@@ -18,7 +18,7 @@ The ``timeoutMS.yml``/``timeoutMS.json`` files in this directory contain tests
 for the ``timeoutMS`` option and its application to the client-side encryption
 feature. Drivers MUST only run these tests after implementing the
 `Client Side Operations Timeout
-<../client-side-operations-timeout/client-side-operations-timeout.rst>`__
+<../client-side-operations-timeout/client-side-operations-timeout.md>`__
 specification.
 
 Additional prose tests, that are not represented in the spec tests, are described

diff --git a/source/command-logging-and-monitoring/command-logging-and-monitoring.rst b/source/command-logging-and-monitoring/command-logging-and-monitoring.rst
@@ -80,7 +80,7 @@ Unacknowledged/Acknowledged Writes
 A non-default write concern MUST be included in the published command. The default write concern is not required to be included.
 
 Succeeded or Failed
-^^^^^^^^^^^^^^^^^^
+^^^^^^^^^^^^^^^^^^^
 
 Commands that executed on the server and return a status of ``{ ok: 1.0 }`` are considered
 successful commands and MUST generate a ``CommandSucceededEvent`` and "command succeeded" log message. 

diff --git a/source/conf.py b/source/conf.py
@@ -15,7 +15,7 @@
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
-extensions = []
+extensions = ["myst_parser"]
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = []

diff --git a/source/connection-monitoring-and-pooling/connection-monitoring-and-pooling.rst b/source/connection-monitoring-and-pooling/connection-monitoring-and-pooling.rst
@@ -567,7 +567,7 @@ once that request reaches the front of the queue, having the Pool find or create
 a `Connection`_ to fulfill that request. Requests MUST be subject to a timeout
 which is computed per the rules in
 `Client Side Operations Timeout: Server Selection
-<../client-side-operations-timeout/client-side-operations-timeout.rst#server-selection>`_.
+<../client-side-operations-timeout/client-side-operations-timeout.md#server-selection>`_.
 
 To service a request for a `Connection`_, the Pool MUST first iterate over the
 list of available `Connections <#connection>`_, searching for a non-perished one
@@ -805,7 +805,7 @@ thread SHOULD
 -  Remove and close perished available `Connections <#connection>`_ including "in use" connections if `interruptInUseConnections` option was set to true in the most recent pool clear.
 - Apply timeouts to connection establishment per `Client Side Operations
   Timeout: Background Connection Pooling
-  <../client-side-operations-timeout/client-side-operations-timeout.rst#background-connection-pooling>`__.
+  <../client-side-operations-timeout/client-side-operations-timeout.md#background-connection-pooling>`__.
 
 A pool SHOULD allow immediate scheduling of the next background thread iteration after a clear is performed. 
 

diff --git a/source/crud/crud.rst b/source/crud/crud.rst
@@ -113,10 +113,10 @@ Timeouts
 
 Drivers MUST enforce timeouts for all operations per the `Client Side
 Operations Timeout
-<../client-side-operations-timeout/client-side-operations-timeout.rst>`__
+<../client-side-operations-timeout/client-side-operations-timeout.md>`__
 specification. All operations that return cursors MUST support the timeout
 options documented in the `Cursors
-<../client-side-operations-timeout/client-side-operations-timeout.rst#Cursors>`__
+<../client-side-operations-timeout/client-side-operations-timeout.md#Cursors>`__
 section of that specification.
 
 ---

diff --git a/source/enumerate-collections.rst b/source/enumerate-collections.rst
@@ -269,12 +269,12 @@ All methods:
 - MUST use the *same* return type (ie, array or cursor) whether either a
   pre-2.7.6 server, a post-2.7.6 or a post-2.8.0-rc3 server is being used.
 - MUST apply timeouts per the `Client Side Operations Timeout
-  <client-side-operations-timeout/client-side-operations-timeout.rst>`__
+  <client-side-operations-timeout/client-side-operations-timeout.md>`__
   specification.
 
 All methods that return cursors MUST support the timeout options documented
 in `Client Side Operations Timeout: Cursors
-<client-side-operations-timeout/client-side-operations-timeout.rst#Cursors>`__.
+<client-side-operations-timeout/client-side-operations-timeout.md#Cursors>`__.
 
 Getting Collection Names
 ~~~~~~~~~~~~~~~~~~~~~~~~

diff --git a/source/enumerate-databases.rst b/source/enumerate-databases.rst
@@ -113,7 +113,7 @@ need to change it. Do not break backwards compatibility when adding new methods.
 All methods SHOULD be implemented on the MongoClient object.
 
 All methods MUST apply timeouts per the `Client Side Operations Timeout
-<client-side-operations-timeout/client-side-operations-timeout.rst>`__
+<client-side-operations-timeout/client-side-operations-timeout.md>`__
 specification.
 
 Enumerating Full Database Information

diff --git a/source/gridfs/gridfs-spec.rst b/source/gridfs/gridfs-spec.rst
@@ -198,7 +198,7 @@ Timeouts
 
 Drivers MUST enforce timeouts for all operations per `Client Side Operations
 Timeout: GridFS API
-<../client-side-operations-timeout/client-side-operations-timeout.rst#gridfs-api>`__.
+<../client-side-operations-timeout/client-side-operations-timeout.md#gridfs-api>`__.
 
 Naming
 ------

diff --git a/source/index-management/index-management.rst b/source/index-management/index-management.rst
@@ -109,10 +109,10 @@ Timeouts
 
 Drivers MUST enforce timeouts for all operations per the `Client Side
 Operations Timeout
-<client-side-operations-timeout/client-side-operations-timeout.rst>`__
+<client-side-operations-timeout/client-side-operations-timeout.md>`__
 specification. All operations that return cursors MUST support the timeout
 options documented in the `Cursors
-<client-side-operations-timeout/client-side-operations-timeout.rst#Cursors>`__
+<client-side-operations-timeout/client-side-operations-timeout.md#Cursors>`__
 section of that specification.
 
 ------------
@@ -1136,4 +1136,4 @@ Changelog
 :2023-05-10:  Merge index enumeration and index management specs and get rid of references 
              to legacy server versions.
 :2023-05-18:  Add the search index management API.
-:2023-07-27:  Add search index management clarifications.
+:2023-07-27:  Add search index management clarifications.
diff --git a/source/mongodb-handshake/handshake.rst b/source/mongodb-handshake/handshake.rst
@@ -88,7 +88,7 @@ connections and newly discovered members of a cluster. It MUST be the first
 command sent over the respective socket. If the command fails the client MUST
 disconnect. Timeouts MUST be applied to this command per the `Client Side
 Operations Timeout
-<../client-side-operations-timeout/client-side-operations-timeout.rst>`__
+<../client-side-operations-timeout/client-side-operations-timeout.md>`__
 specification.
 
 ``hello`` and legacy hello commands issued after the initial connection handshake

diff --git a/source/ocsp-support/ocsp-support.rst b/source/ocsp-support/ocsp-support.rst
@@ -105,7 +105,7 @@ invalid, the driver SHOULD end the connection.
     response that concretely marks the certificate status as good or revoked
     should be used. A timeout should be applied to requests per the `Client
     Side Operations Timeout
-    <../client-side-operations-timeout/client-side-operations-timeout.rst>`__
+    <../client-side-operations-timeout/client-side-operations-timeout.md>`__
     specification, with a default timeout of five seconds. The status for a
     response should only be checked if the response is valid per `RFC 6960
     Section 3.2 <https://tools.ietf.org/html/rfc6960#section-3.2>`_

diff --git a/source/read-write-concern/read-write-concern.rst b/source/read-write-concern/read-write-concern.rst
@@ -327,7 +327,7 @@ wtimeoutMS
 ----------
 
 ``wtimeoutMS`` MUST be considered deprecated in favor of `timeoutMS
-<client-side-operations-timeout/client-side-operations-timeout.rst#timeoutMS>`__.
+<client-side-operations-timeout/client-side-operations-timeout.md#timeoutMS>`__.
 
 
 Server’s Default WriteConcern

diff --git a/source/retryable-reads/retryable-reads.rst b/source/retryable-reads/retryable-reads.rst
@@ -658,7 +658,7 @@ during planned maintenance events.
 
 .. _SDAM: ../server-discovery-and-monitoring/server-discovery-and-monitoring.rst
 .. _How To Write Resilient MongoDB Applications: https://emptysqua.re/blog/how-to-write-resilient-mongodb-applications/
-.. _Client Side Operations Timeout: ../client-side-operations-timeout/client-side-operations-timeout.rst
+.. _Client Side Operations Timeout: ../client-side-operations-timeout/client-side-operations-timeout.md
 
 Can drivers resend the same wire protocol message on retry attempts?
 --------------------------------------------------------------------

diff --git a/source/retryable-writes/retryable-writes.rst b/source/retryable-writes/retryable-writes.rst
@@ -392,7 +392,7 @@ of the following conditions is reached:
 - the operation fails with a non-retryable error.
 - CSOT is enabled and the operation times out per `Client Side
   Operations Timeout: Retryability
-  <../client-side-operations-timeout/client-side-operations-timeout.rst#retryability>`__.
+  <../client-side-operations-timeout/client-side-operations-timeout.md#retryability>`__.
 - CSOT is not enabled and one retry was attempted.
 
 For each retry attempt, drivers MUST select a writable server. In a sharded
@@ -692,7 +692,7 @@ during planned maintenance events.
 
 .. _SDAM: ../server-discovery-and-monitoring/server-discovery-and-monitoring.rst
 .. _How To Write Resilient MongoDB Applications: https://emptysqua.re/blog/how-to-write-resilient-mongodb-applications/
-.. _Client Side Operations Timeout: ../client-side-operations-timeout/client-side-operations-timeout.rst
+.. _Client Side Operations Timeout: ../client-side-operations-timeout/client-side-operations-timeout.md
 
 What if the transaction number overflows?
 -----------------------------------------

diff --git a/source/run-command/run-command.rst b/source/run-command/run-command.rst
@@ -84,7 +84,7 @@ The following represents how a runCommand API SHOULD be exposed.
        * An optional timeout option to govern the amount of time that a single operation can execute before control is returned to the user.
        * This timeout applies to all of the work done to execute the operation, including but not limited to server selection, connection checkout, and server-side execution.
        *
-       * @ see https://github.com/mongodb/specifications/blob/master/source/client-side-operations-timeout/client-side-operations-timeout.rst
+       * @ see https://github.com/mongodb/specifications/blob/master/source/client-side-operations-timeout/client-side-operations-timeout.md
        */
       timeoutMS?: number;
     }
@@ -190,8 +190,8 @@ RunCommand MUST provide an optional ``timeoutMS`` option to support client side
 Drivers MUST NOT attempt to check the command document for the presence of a ``maxTimeMS`` field.
 Drivers MUST document the behavior of RunCommand if a ``maxTimeMS`` field  is already set on the command (such as overwriting the command field).
 
-* See Client Side Operations Timeout's section on `runCommand <https://github.com/mongodb/specifications/blob/master/source/client-side-operations-timeout/client-side-operations-timeout.rst#runcommand>`_
-* See Client Side Operations Timeout's section on `runCommand behavior <https://github.com/mongodb/specifications/blob/master/source/client-side-operations-timeout/client-side-operations-timeout.rst#runcommand-behavior>`_
+* See Client Side Operations Timeout's section on `runCommand <https://github.com/mongodb/specifications/blob/master/source/client-side-operations-timeout/client-side-operations-timeout.md#runcommand>`_
+* See Client Side Operations Timeout's section on `runCommand behavior <https://github.com/mongodb/specifications/blob/master/source/client-side-operations-timeout/client-side-operations-timeout.md#runcommand-behavior>`_
 
 
 --------------------
@@ -217,7 +217,7 @@ Drivers MAY expose a runCursorCommand API with the following syntax.
        *
        * @defaultValue CURSOR_LIFETIME
        *
-       * @see https://github.com/mongodb/specifications/blob/master/source/client-side-operations-timeout/client-side-operations-timeout.rst
+       * @see https://github.com/mongodb/specifications/blob/master/source/client-side-operations-timeout/client-side-operations-timeout.md
        */
       timeoutMode?: ITERATION | CURSOR_LIFETIME;
 
@@ -334,7 +334,7 @@ Drivers MUST document that attempting to set both options can have undefined beh
 
 When ``timeoutMS`` and ``timeoutMode`` are provided the driver MUST support timeout functionality as described in the CSOT specification.
 
-* See Client Side Operations Timeout's section on `Cursors <https://github.com/mongodb/specifications/blob/master/source/client-side-operations-timeout/client-side-operations-timeout.rst#cursors>`_
+* See Client Side Operations Timeout's section on `Cursors <https://github.com/mongodb/specifications/blob/master/source/client-side-operations-timeout/client-side-operations-timeout.md#cursors>`_
 
 Changelog
 =========

diff --git a/source/server-discovery-and-monitoring/server-monitoring.rst b/source/server-discovery-and-monitoring/server-monitoring.rst
@@ -1253,8 +1253,8 @@ Changelog
 .. _OP_MSG exhaustAllowed flag: /source/message/OP_MSG.rst#exhaustAllowed
 .. _Connection Pool: /source/connection-monitoring-and-pooling/connection-monitoring-and-pooling.rst#Connection-Pool
 .. _Why synchronize clearing a server's pool with updating the topology?: server-discovery-and-monitoring.rst#why-synchronize-clearing-a-server-s-pool-with-updating-the-topology?
-.. _Client Side Operations Timeout Spec: /source/client-side-operations-timeout/client-side-operations-timeout.rst
-.. _timeoutMS: /source/client-side-operations-timeout/client-side-operations-timeout.rst#timeoutMS
+.. _Client Side Operations Timeout Spec: /source/client-side-operations-timeout/client-side-operations-timeout.md
+.. _timeoutMS: /source/client-side-operations-timeout/client-side-operations-timeout.md#timeoutMS
 .. _Why does the pool need to support closing in use connections as part of its clear logic?: /source/connection-monitoring-and-pooling/connection-monitoring-and-pooling.rst#Why-does-the-pool-need-to-support-closing-in-use-connections-as-part-of-its-clear-logic?
 .. _DRIVERS-2246: https://jira.mongodb.org/browse/DRIVERS-2246
 .. _MongoDB Handshake spec: /source/mongodb-handshake/handshake.rst#client-env
diff --git a/source/server-selection/server-selection.rst b/source/server-selection/server-selection.rst
@@ -797,7 +797,7 @@ Multi-threaded drivers and single-threaded drivers with
 ``serverSelectionTryOnce`` set to false MUST enforce a timeout for the server
 selection process. The timeout MUST be computed as described in
 `Client Side Operations Timeout: Server Selection
-<../client-side-operations-timeout/client-side-operations-timeout.rst#server-selection>`_.
+<../client-side-operations-timeout/client-side-operations-timeout.md#server-selection>`_.
 
 Multi-threaded or asynchronous server selection
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

diff --git a/source/transactions-convenient-api/transactions-convenient-api.rst b/source/transactions-convenient-api/transactions-convenient-api.rst
@@ -114,7 +114,7 @@ allowed to execute other operations not associated with the transaction.
 Since ``withTransaction`` includes logic to retry transactions and commits,
 drivers MUST apply timeouts per `Client Side Operations Timeout: Convenient
 Transactions API
-<../client-side-operations-timeout/client-side-operations-timeout.rst#convenient-transactions-api>`__.
+<../client-side-operations-timeout/client-side-operations-timeout.md#convenient-transactions-api>`__.
 If ``timeoutMS`` is unset for a ``withTransaction`` call, drivers MUST
 enforce a 120-second timeout to limit retry behavior and safeguard
 applications from long-running (or infinite) retry loops. Drivers SHOULD use

diff --git a/source/transactions/transactions.rst b/source/transactions/transactions.rst
@@ -299,7 +299,7 @@ maxCommitTimeMS
 ^^^^^^^^^^^^^^^
 
 NOTE: This option is deprecated in favor of `timeoutMS
-<../client-side-operations-timeout/client-side-operations-timeout.rst#timeoutMS>`_.
+<../client-side-operations-timeout/client-side-operations-timeout.md#timeoutMS>`_.
 
 The maximum amount of time to allow a single commitTransaction command to run.
 

diff --git a/source/unified-test-format/unified-test-format.rst b/source/unified-test-format/unified-test-format.rst
@@ -775,7 +775,7 @@ The structure of this object is as follows:
     - `Causal Consistency <../causal-consistency/causal-consistency.rst#sessionoptions-changes>`__
     - `Snapshot Reads <../sessions/snapshot-sessions.rst#sessionoptions-changes>`__
     - `Transactions <../transactions/transactions.rst#sessionoptions-changes>`__
-    - `Client Side Operations Timeout <../client-side-operations-timeout/client-side-operations-timeout.rst#sessions>`__
+    - `Client Side Operations Timeout <../client-side-operations-timeout/client-side-operations-timeout.md#sessions>`__
 
     When specifying TransactionOptions for ``defaultTransactionOptions``, the
     transaction options MUST remain nested under ``defaultTransactionOptions``

diff --git a/source/uri-options/uri-options.rst b/source/uri-options/uri-options.rst
@@ -315,7 +315,7 @@ pertaining to URI options apply here.
      - non-negative integer; 0 means no timeout
      - no timeout
      - no
-     - NOTE: This option is deprecated  in favor of `timeoutMS <../client-side-operations-timeout/client-side-operations-timeout.rst#timeoutMS>`_
+     - NOTE: This option is deprecated  in favor of `timeoutMS <../client-side-operations-timeout/client-side-operations-timeout.md#timeoutMS>`_
 
        Amount of time spent attempting to send or receive on a socket before timing out; note that this only applies to application operations, not SDAM.
 
@@ -343,7 +343,7 @@ pertaining to URI options apply here.
    *
      - timeoutMS
      - non-negative integer; 0 or unset means no timeout
-     - Defined in `Client Side Operations Timeout: timeoutMS <../client-side-operations-timeout/client-side-operations-timeout.rst#timeoutMS>`_.
+     - Defined in `Client Side Operations Timeout: timeoutMS <../client-side-operations-timeout/client-side-operations-timeout.md#timeoutMS>`_.
      - no
      - Time limit for the full execution of an operation
 
@@ -422,7 +422,7 @@ pertaining to URI options apply here.
      - positive number
      - defined in the `Connection Pooling spec`_
      - required for drivers with connection pools, with exceptions described in the `Connection Pooling spec`_
-     - NOTE: This option is deprecated  in favor of `timeoutMS <../client-side-operations-timeout/client-side-operations-timeout.rst#timeoutMS>`_
+     - NOTE: This option is deprecated  in favor of `timeoutMS <../client-side-operations-timeout/client-side-operations-timeout.md#timeoutMS>`_
 
        Amount of time spent attempting to check out a connection from a server's
        connection pool before timing out
@@ -431,7 +431,7 @@ pertaining to URI options apply here.
      - non-negative 64-bit integer; 0 means no timeout
      - no timeout
      - no
-     - NOTE: This option is deprecated  in favor of `timeoutMS <../client-side-operations-timeout/client-side-operations-timeout.rst#timeoutMS>`_
+     - NOTE: This option is deprecated  in favor of `timeoutMS <../client-side-operations-timeout/client-side-operations-timeout.md#timeoutMS>`_
 
        Default write concern "wtimeout" field for the client
Original file line number	Diff line number	Diff line change
Expand Up		@@ -8,4 +8,3 @@ Please complete the following before merging:
		- [ ] Test these changes against all server versions and topologies (including standalone, replica set, sharded clusters, and serverless).

		<!-- See also: https://wiki.corp.mongodb.com/pages/viewpage.action?pageId=80806719 -->