Merge branch 'master' into DOCSP-41148

Author: lindseymoore

.github/workflows/backport.yml

@@ -0,0 +1,26 @@
+name: Backport
+on:
+  pull_request_target:
+    types:
+      - closed
+      - labeled
+
+jobs:
+  backport:
+    name: Backport
+    runs-on: ubuntu-latest
+    # Only react to merged PRs for security reasons.
+    # See https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#pull_request_target.
+    if: >
+      github.event.pull_request.merged
+      && (
+        github.event.action == 'closed'
+        || (
+          github.event.action == 'labeled'
+          && contains(github.event.label.name, 'backport')
+        )
+      )
+    steps:
+      - uses: tibdex/backport@v2
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/copy-compat-to-docs-shared.yml

@@ -12,23 +12,26 @@ jobs:
       - name: checkout
         uses: actions/checkout@master
 
+      - name: Install docutils
+        run: sudo apt-get install -y docutils
+
       - id: files
         uses: masesgroup/retrieve-changed-files@v2
         with:
-          format: 'csv'
+          format: "csv"
 
       - name: checkout-latest-rules
         uses: actions/checkout@master
         with:
           repository: mongodb/mongodb-vale-action
-          path: './tdbx-vale-rules'
+          path: "./tdbx-vale-rules"
           token: ${{secrets.GITHUB_TOKEN}}
 
       - name: move-files-for-vale-action
         run: |
-            cp tdbx-vale-rules/.vale.ini .vale.ini
-            mkdir -p .github/styles/
-            cp -rf tdbx-vale-rules/.github/styles/ .github/
+          cp tdbx-vale-rules/.vale.ini .vale.ini
+          mkdir -p .github/styles/
+          cp -rf tdbx-vale-rules/.github/styles/ .github/
 
       - name: run-vale
         uses: errata-ai/vale-action@reviewdog

.github/workflows/vale-tdbx.yml

@@ -22,11 +22,11 @@ Connect to MongoDB
    :titlesonly:
    :maxdepth: 1
 
-   /connect/mongoclient
-   /connect/connection-targets
-   /connect/connection-options
-   /connect/tls
-   /connect/stable-api
+   Create a MongoClient </connect/mongoclient>
+   Choose a Connection Target </connect/connection-targets>
+   Connection Options </connect/connection-options>
+   Enable TLS </connect/tls>
+   Stable API </connect/stable-api>
 
 ..    /connect/network-compression
 ..    /connect/server-selection

source/connect.txt

@@ -21,10 +21,10 @@ Specialized Data Formats
    :titlesonly:
    :maxdepth: 1
 
-   /data-formats/serialization
-   /data-formats/codecs
-   /data-formats/bson
-   /data-formats/time-series
+   Kotlin Serialization </data-formats/serialization>
+   Codecs </data-formats/codecs>
+   BSON </data-formats/bson>
+   Time Series </data-formats/time-series>
 
 ..     TODO: /data-formats/data-class
 ..     TODO: /data-formats/extended-json

source/data-formats.txt

@@ -339,7 +339,7 @@ corresponding ``Codec`` to handle encoding and decoding:
   kelvins as an ``Int`` value. For this field, use the ``IntegerCodec``
   provided in the BSON library.
 
-The following code shows how to can implement a ``Codec`` for the
+The following code shows how to implement a ``Codec`` for the
 ``Monolight`` class. The constructor expects an instance of
 ``CodecRegistry`` from which it retrieves the ``Codec`` instances needed
 to encode and decode the class fields:

source/data-formats/codecs.txt

@@ -20,11 +20,11 @@ Get Started with the Kotlin Sync Driver
 
 .. toctree::
 
-   /get-started/download-and-install/
-   /get-started/create-a-deployment/
-   /get-started/create-a-connection-string/
-   /get-started/connect-to-mongodb/
-   /get-started/next-steps/
+   Download & Install </get-started/download-and-install/>
+   Create a Deployment </get-started/create-a-deployment/>
+   Create a Connection String </get-started/create-a-connection-string/>
+   Connect </get-started/connect-to-mongodb/>
+   Next Steps </get-started/next-steps/>
 
 Overview
 --------

source/get-started.txt

@@ -14,19 +14,19 @@
 .. toctree::
 
    Get Started </get-started>
-   /connect
-   /write-operations
-   /read
-   /indexes
-   /aggregation
-   Use Aggregation Expression Operations </agg-exp-ops>
-   /security
-   /data-formats
-   /builders
-   /encrypt-fields
-   /compatibility
-   Validate Driver Artifact Signatures </validate-signatures>
-   /whats-new
+   Connect </connect>
+   Write Data </write-operations>
+   Read Data </read>
+   Indexes </indexes>
+   Data Aggregation </aggregation>
+   Aggregation Operations </agg-exp-ops>
+   Specialized Data Formats </data-formats>
+   Builders </builders>
+   In-Use Encryption </encrypt-fields>
+   Compatibility </compatibility>
+   Validate Driver Signatures </validate-signatures>
+   What's New </whats-new>
+   Issues & Help </issues-and-help>
    View the Source <https://github.com/mongodb/mongo-java-driver/tree/master/driver-kotlin-sync>
    API Documentation <{+api+}/com.mongodb.kotlin.client/index.html>
 
@@ -60,12 +60,6 @@ Connect to MongoDB
 Learn how to create and configure a connection to a MongoDB deployment
 in the :ref:`kotlin-sync-connect` section.
 
-What's New
-----------
-
-For a list of new features and changes in each version, see the :ref:`What's New <kotlin-sync-whats-new>`
-section.
-
 Write Data to MongoDB
 ---------------------
 
@@ -108,38 +102,32 @@ In-Use Encryption
 Learn how to use in-use encryption to encrypt your MongoDB data in the
 :ref:`In-Use Encryption <kotlin-sync-fle>` section.
 
-.. TODO: Uncomment when pages are created
-.. FAQ
-.. ---
-
-.. For answers to commonly asked questions about the {+driver-short+}, see the
-.. :ref:`FAQ <kotlin-sync-faq>` section.
-
-.. Connection Troubleshooting
-.. --------------------------
-
-.. For solutions to some issues you might experience when connecting to a MongoDB
-.. deployment while using the {+driver-short+}, see the 
-.. :ref:`Connection Troubleshooting <kotlin-sync-connection-troubleshooting>` section.
-
-.. Issues & Help
-.. -------------
-
-.. Learn how to report bugs, contribute to the driver, and find more resources for
-.. asking questions and receiving help in the :ref:`Issues & Help <kotlin-sync-issues-and-help>` section.
-
 Compatibility
 -------------
 
 For the compatibility charts that show the recommended {+driver-short+} version for each
-MongoDB Server version, see the :ref:`Compatibility <kotlin-sync-compatibility>` section.
+MongoDB Server version, see the :ref:`Compatibility
+<kotlin-sync-compatibility>` section.
 
 Validate Driver Artifact Signatures
 -----------------------------------
 
 Learn about how to validate signatures of {+driver-short+} artifacts
 published on Maven in the :ref:`Validate Driver Artifact Signatures <kotlin-sync-validate-signatures>` section.
 
+What's New
+----------
+
+For a list of new features and changes in each version, see the
+:ref:`What's New <kotlin-sync-whats-new>` section.
+
+Issues & Help
+-------------
+
+Learn how to report bugs, contribute to the driver, and find more resources for
+asking questions and receiving help in the :ref:`Issues & Help
+<kotlin-sync-issues-and-help>` section.
+
 Learn
 ------
 
@@ -155,4 +143,19 @@ To learn how to use MongoDB features with the {+driver-short+}, see the
 `How-Tos and Articles page <https://www.mongodb.com/developer/languages/kotlin/>`__.
 
 To ask questions and engage in discussions with fellow developers who
-use the {+driver-short+}, see the `forums page <https://www.mongodb.com/community/forums/tag/kotlin>`__.
+use the {+driver-short+}, see the `forums page.
+<https://www.mongodb.com/community/forums/tag/kotlin>`__
+
+.. TODO: Uncomment when pages are created
+.. FAQ
+.. ---
+
+.. For answers to commonly asked questions about the {+driver-short+}, see the
+.. :ref:`FAQ <kotlin-sync-faq>` section.
+
+.. Connection Troubleshooting
+.. --------------------------
+
+.. For solutions to some issues you might experience when connecting to a MongoDB
+.. deployment while using the {+driver-short+}, see the 
+.. :ref:`Connection Troubleshooting <kotlin-sync-connection-troubleshooting>` section.

source/includes/mongodb-compatibility-table-kotlin-sync.rst

@@ -22,7 +22,7 @@ Optimize Queries by Using Indexes
    :titlesonly:
    :maxdepth: 1
 
-   /work-with-indexes
+   Work with Indexes </work-with-indexes>
 
 Overview
 --------