Merge remote-tracking branch 'upstream/v2.21' into v2.21

norareidy · norareidy · commit d2cc65e04f54 · 2025-03-11T10:06:08.000-04:00
diff --git a/snooty.toml b/snooty.toml
@@ -2,3 +2,8 @@ name = "ruby-driver"
 title = "Ruby MongoDB Driver"
 
 intersphinx = ["https://www.mongodb.com/docs/manual/objects.inv"]
+
+sharedinclude_root = "https://raw.githubusercontent.com/10gen/docs-shared/main/"
+
+[constants]
+driver-short = "Ruby driver"
diff --git a/source/getting-started.txt b/source/getting-started.txt
@@ -6,12 +6,12 @@ Getting Started
 
 .. default-domain:: mongodb
 
-This section describes how to install the driver, installation prerequisites
-and compatibility considerations.
-
 .. toctree::
   :titlesonly:
 
-  installation
-  reference/driver-compatibility
-  support
+  Installation <installation>
+  Driver Compatibility <reference/driver-compatibility>
+  Support <support>
+
+This section describes how to install the driver, installation prerequisites,
+and compatibility considerations.
diff --git a/source/index.txt b/source/index.txt
@@ -8,6 +8,21 @@ Ruby MongoDB Driver
 
 .. default-domain:: mongodb
 
+.. class:: hidden
+
+  .. toctree::
+    :titlesonly:
+
+    Get Started <getting-started>
+    Tutorials <tutorials>
+    Connection & Configuration <reference/connection-and-configuration>
+    Working with Data <reference/working-with-data>
+    Schema Operations <reference/schema-operations>
+    API <https://mongodb.com/docs/ruby-driver/current/api/>
+    Release Notes <release-notes>
+    Additional Resources <reference/additional-resources>
+    Contribute <contribute>
+
 Welcome to the documentation site for the official MongoDB Ruby driver.
 You can add the driver to your application to work with MongoDB in
 Ruby.
@@ -49,19 +64,4 @@ For tutorials on Mongoid, see the `Mongoid Manual <https://mongodb.com/docs/mong
 .. COMMENT  For the actual build, see mongodb/docs-ruby repo which pulls the documentation source from:
 ..    mongo-ruby-driver,
 ..    bson-ruby, and
-..    mongoid repos.
-
-.. class:: hidden
-
-  .. toctree::
-    :titlesonly:
-
-    getting-started
-    tutorials
-    reference/connection-and-configuration
-    reference/working-with-data
-    reference/schema-operations
-    API <https://mongodb.com/docs/ruby-driver/current/api/>
-    release-notes
-    reference/additional-resources
-    contribute
+..    mongoid repos.
diff --git a/source/reference/aggregation.txt b/source/reference/aggregation.txt
@@ -98,6 +98,14 @@ find the total number of documents which have the exact array
 
   count = coll.count({ 'categories' => [ 'Chinese', 'Seafood' ] })
 
+.. note::
+
+   The ``count`` method is not the same as the ``countDocuments``
+   method and may not support the same filters. ``countDocuments`` uses the
+   ``$match`` stage of the aggregation pipeline to filter documents. To learn more
+   about limitations of the ``$match`` stage, see :manual:`$match Restrictions </reference/operator/aggregation/match/#restrictions>`
+   in the MongoDB Server manual.
+
 Distinct
 ~~~~~~~~
 
diff --git a/source/reference/connection-and-configuration.txt b/source/reference/connection-and-configuration.txt
@@ -6,13 +6,13 @@ Connection & Configuration
 
 .. default-domain:: mongodb
 
-This section describes how to create the client objects and what configuration
-options the driver provides, including authentication.
-
 .. toctree::
   :titlesonly:
 
-  /reference/create-client
-  /reference/authentication
-  /reference/monitoring
-  /reference/user-management
+  Create a Client </reference/create-client>
+  Authentication </reference/authentication>
+  Monitoring </reference/monitoring>
+  User Management </reference/user-management>
+
+This section describes how to create the client objects and what configuration
+options the driver provides, including authentication.
diff --git a/source/reference/crud-operations.txt b/source/reference/crud-operations.txt
@@ -285,15 +285,13 @@ when querying and their corresponding methods as examples.
        If the read concern is specifed on the client or collection level, or
        if the read concern is specified as a find option, it will NOT be passed
        by the driver to the explain command.
-
-       .. note::
-
-         The information returned by the server for the ``explain`` command
-         varies with server version and deployment topology. The driver's
-         ``explain`` method returns whatever the server provided.
-
-         **The return value of ``explain`` method is not part of the driver's
-         public API and depends on the server version and deployment topology.**
+       
+       The information returned by the server for the ``explain`` command 
+       varies with server version and deployment topology. The driver's
+       ``explain`` method returns whatever the server provided.
+       
+       **The return value of the ``explain`` method is not part of the driver's
+       public API and depends on the server version and deployment topology.**
 
    * - ``hint(Hash)``
      - Provides the query with an
diff --git a/source/reference/in-use-encryption.txt b/source/reference/in-use-encryption.txt
@@ -6,12 +6,12 @@ In-Use Encryption
 
 .. default-domain:: mongodb
 
-This section describes the different encryption methods in use by the Ruby
-driver for MongoDB.
-
 .. toctree::
   :titlesonly:
 
-  /reference/in-use-encryption/queryable-encryption
-  /reference/in-use-encryption/client-side-encryption
+  Queryable Encryption </reference/in-use-encryption/queryable-encryption>
+  Client-Side Encryption </reference/in-use-encryption/client-side-encryption>
+
+This section describes the different encryption methods in use by the Ruby
+driver for MongoDB.
   
diff --git a/source/reference/schema-operations.txt b/source/reference/schema-operations.txt
@@ -12,8 +12,8 @@ including managing databases, collections, indexes and users.
 .. toctree::
   :titlesonly:
 
-  /reference/database-tasks
-  /reference/collection-tasks
-  /reference/indexing
-  /reference/search-indexes
-  /reference/collations
+  Databases </reference/database-tasks>
+  Collections </reference/collection-tasks>
+  Indexes </reference/indexing>
+  Atlas Search Indexes </reference/search-indexes>
+  Collations </reference/collations>
diff --git a/source/reference/transactions.txt b/source/reference/transactions.txt
@@ -2,8 +2,6 @@
 Transactions
 ************
 
-.. default-domain:: mongodb
-
 .. contents:: On this page
    :local:
    :backlinks: none
@@ -16,6 +14,8 @@ Version 4.0 of the MongoDB server introduces
 (Updates to multiple fields within a single document are atomic in all
 versions of MongoDB.) Ruby driver version 2.6.0 adds support for transactions.
 
+.. sharedinclude:: dbx/transactions-parallelism.rst
+
 .. _using-transactions:
 
 Using Transactions
diff --git a/source/reference/working-with-data.txt b/source/reference/working-with-data.txt
@@ -12,16 +12,16 @@ implements for inserting, updating and retrieving data from MongoDB.
 .. toctree::
   :titlesonly:
 
-  /reference/crud-operations
-  /reference/bulk-operations
-  /reference/projection
-  /reference/aggregation
-  /reference/map-reduce
-  /reference/text-search
-  /reference/geospatial-search
-  /reference/query-cache
-  /reference/gridfs
-  /reference/change-streams
-  /reference/sessions
-  /reference/transactions
-  /reference/in-use-encryption
+  CRUD </reference/crud-operations>
+  Bulk Writes </reference/bulk-operations>
+  Projection </reference/projection>
+  Aggregation </reference/aggregation>
+  MapReduce </reference/map-reduce>
+  Text Search </reference/text-search>
+  Geospatial Search </reference/geospatial-search>
+  Query Cache </reference/query-cache>
+  GridFS </reference/gridfs>
+  Change Streams </reference/change-streams>
+  Sessions </reference/sessions>
+  Transactions </reference/transactions>
+  In-Use Encryption </reference/in-use-encryption>
diff --git a/source/release-notes.txt b/source/release-notes.txt
diff --git a/source/tutorials.txt b/source/tutorials.txt
