DOCSP-46650: Cleanup

norareidy · norareidy · commit 67bf7ddb343a · 2025-01-27T16:00:20.000-05:00
diff --git a/snooty.toml b/snooty.toml
@@ -2,7 +2,6 @@ name = "ruby-driver"
 title = "Ruby MongoDB Driver"
 toc_landing_pages = [
     "/get-started",
-    "/connect",
     "/write",
     "/indexes",
     "/databases-collection",
diff --git a/source/aggregation.txt b/source/aggregation.txt
@@ -199,9 +199,8 @@ This example creates pipeline stages to perform the following actions:
 
     To run the following example, you must create an Atlas Search index on the ``restaurants``
     collection that covers the ``name`` field. Then, replace the ``"<your_search_index_name>"``
-    placeholder with the name of the index. 
-
-.. TODO: Add a link in the callout to the Atlas Search index creation guide.
+    placeholder with the name of the index. To learn how to create an Atlas Search index,
+    see the :ref:`ruby-atlas-search-index` guide.
 
 .. io-code-block::
     :copyable:
diff --git a/source/connect/connection-targets.txt b/source/connect/connection-targets.txt
@@ -29,9 +29,9 @@ Atlas
 To connect to a MongoDB deployment on Atlas, include the following elements
 in your connection string:
 
-- The URL of your Atlas cluster
-- Your MongoDB username
-- Your MongoDB password
+- URL of your Atlas cluster
+- MongoDB username
+- MongoDB password
 
 Then, pass your connection string to the ``Mongo::Client`` constructor.
 
diff --git a/source/connect/mongoclient.txt b/source/connect/mongoclient.txt
@@ -56,8 +56,8 @@ A standard connection string includes the following components:
 
      - Optional. Authentication credentials. If you include these, the client
        authenticates the user against the database specified in ``authSource``.
-       For more information about the ``authSource`` connection option, see
-       :ref:`ruby-auth`. 
+       For more information about the ``authSource`` connection option, see the
+       :ref:`ruby-authentication-mechanisms` guide. 
 
    * - ``hostname[:port]``
 
diff --git a/source/data-formats/time-series.txt b/source/data-formats/time-series.txt
@@ -171,11 +171,11 @@ Query Time Series Data
 
 You can use the same syntax and conventions to query data stored in a time 
 series collection as you use when performing read or aggregation operations on 
-other collections. 
+other collections. To learn more about these operations, see the following
+guides:
 
-.. TODO: add links
-.. To learn more about these operations, see :ref:`ruby-read`
-.. and :ref:`ruby-aggregation`.
+- :ref:`ruby-read`
+- :ref:`ruby-aggregation`
 
 .. _ruby-time-series-addtl-info:
 
diff --git a/source/databases-collection.txt b/source/databases-collection.txt
@@ -250,12 +250,6 @@ within 35 milliseconds of the closest member's ping time.
    :manual:`localThreshold </reference/program/mongos/#std-option-mongos.--localThreshold>`
    command-line option.
 
-.. TODO: 
-.. Troubleshooting
-.. ---------------
-
-.. .. include:: /includes/usage-examples/databases-collection.rb
-
 API Documentation
 -----------------
 
diff --git a/source/get-started/create-a-connection-string.txt b/source/get-started/create-a-connection-string.txt
@@ -13,9 +13,8 @@ The connection string includes the hostname or IP address and
 port of your deployment, the authentication mechanism, user credentials 
 when applicable, and connection options.
 
-.. TODO:
- To connect to an instance or deployment not hosted on Atlas, see
- :ref:`ruby-connection-targets`.
+To learn how to connect to an instance or deployment not hosted on
+Atlas, see the :ref:`ruby-connection-targets` guide.
 
 .. procedure::
    :style: connected
diff --git a/source/get-started/next-steps.txt b/source/get-started/next-steps.txt
@@ -17,7 +17,7 @@ In this tutorial, you created a {+language+} application that
 connects to a MongoDB deployment hosted on MongoDB Atlas
 and retrieves a document that matches a query.
 
-.. TODO:
- Learn more about {+driver-short+} from the following resources:
- - Learn how to perform read operations in the :ref:`<ruby-read>` section.
- - Learn how to perform write operations in the :ref:`<ruby-write>` section.
+Learn more about the {+driver-short+} from the following resources:
+
+- Learn how to perform read operations in the :ref:`<ruby-read>` section.
+- Learn how to perform write operations in the :ref:`<ruby-write>` section.
diff --git a/source/index.txt b/source/index.txt
@@ -14,8 +14,8 @@
 
    Get Started </get-started>
    Connect </connect>
-   Write Data </write>
    Read Data </read>
+   Write Data </write>
    Operations on Replica Sets </read-write-pref> 
    Indexes </indexes>
    Data Aggregation </aggregation>
@@ -29,9 +29,7 @@
    Databases & Collections </databases-collection>
 
 .. TODO:
- Write Data </write>
  Monitor Your Application </monitoring>
- Security </security>
  Issues & Help </issues-and-help>
 
 Introduction
@@ -58,39 +56,39 @@ Databases and Collections
 Learn how to use the {+driver-short+} to work with MongoDB databases and collections in the
 :ref:`ruby-databases-collections` section.
 
-.. Read Data from MongoDB
-.. ----------------------
+Read Data from MongoDB
+----------------------
 
-.. Learn how you can retrieve data from MongoDB in the :ref:`ruby-read` section.
+Learn how you can retrieve data from MongoDB in the :ref:`ruby-read` section.
 
-.. Write Data to MongoDB
-.. ---------------------
+Write Data to MongoDB
+---------------------
 
-.. Learn how you can write data to MongoDB in the :ref:`ruby-write` section.
+Learn how you can write data to MongoDB in the :ref:`ruby-write` section.
 
 Configure Operations on Replica Sets
 ------------------------------------
 
 Learn how to configure read and write operations on a replica set in the
 :ref:`ruby-crud-write-read-pref` section.
 
-.. Optimize Queries by Using Indexes
-.. ---------------------------------
+Optimize Queries by Using Indexes
+---------------------------------
 
-.. Learn how to work with common types of indexes in the :ref:`ruby-indexes`
-.. section.
+Learn how to work with common types of indexes in the :ref:`ruby-indexes`
+section.
 
 Transform Your Data with Aggregation
 ------------------------------------
 
 Learn how to use the {+driver-short+} to perform aggregation operations in the
 :ref:`ruby-aggregation` section.
 
-.. Secure Your Data
-.. ----------------
+Secure Your Data
+----------------
 
-.. Learn how to authenticate your application and encrypt your data in the
-.. :ref:`ruby-security` section.
+Learn how to authenticate your application and encrypt your data in the
+:ref:`ruby-security` section.
 
 Specialized Data Formats
 ------------------------
diff --git a/source/read-write-pref.txt b/source/read-write-pref.txt
@@ -143,8 +143,10 @@ The following code sets the read concern level of an aggregation to ``"available
    :start-after: start-read-concern
    :end-before: end-read-concern
 
-.. TODO: insert :ref:`Aggregation <ruby-aggregation>` link here
-.. For more information about aggregation, see the Aggregation page.
+.. tip::
+
+   To learn more about aggregation operations, see the
+   :ref:`ruby-aggregation` guide.
 
 Example: Change the Read Concern of a Database
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -206,8 +208,10 @@ the operations in a transaction:
    :start-after: start-read-preference
    :end-before: end-read-preference
 
-.. TODO: insert :ref:`Transactions <ruby-transactions>` link
-.. For more information about transactions, see the Transactions guide.
+.. tip::
+
+   To learn more about transactions, see the
+   :ref:`ruby-transactions` guide.
 
 Example: Set the Read Preference of a Cluster in the Connection String
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
diff --git a/source/read/count.txt b/source/read/count.txt
@@ -57,7 +57,10 @@ Use the ``count_documents`` method to count the number of documents
 in a collection. To count the number of documents that match specific search criteria,
 pass a query filter to the ``count_documents`` method.
 
-.. TODO: To learn more about specifying a query, see the :ref:`ruby-specify-query` guide.
+.. tip::
+  
+   To learn more about specifying a query, see the :ref:`ruby-specify-query`
+   guide.
 
 .. _ruby-count-all:
 
diff --git a/source/read/distinct.txt b/source/read/distinct.txt
@@ -89,7 +89,10 @@ You can provide a **query filter** to the ``distinct`` method to find the distin
 field values across a subset of documents in a collection. A query filter is an expression
 that specifies search criteria used to match documents in an operation. 
 
-.. TODO: To learn more about creating a query filter, see the :ref:`ruby-specify-query` guide.
+.. tip::
+
+   To learn more about creating a query filter, see the :ref:`ruby-specify-query`
+   guide.
 
 The following example retrieves the distinct values of the ``borough`` field for
 all documents that have a ``cuisine`` field value of ``'Italian'``:
diff --git a/source/read/retrieve.txt b/source/read/retrieve.txt
@@ -57,7 +57,9 @@ object from which you can access the results.
 
 You can chain option methods to the ``find`` method to refine the results of the operation.
 
-.. TODO: To learn more about query filters, see the :ref:`ruby-specify-query` guide.
+.. tip::
+
+   To learn more about query filters, see the :ref:`ruby-specify-query` guide.
 
 .. _ruby-retrieve-find-multiple:
 
@@ -225,9 +227,10 @@ method.
 Additional Information
 ----------------------
 
-.. TODO:
- To learn more about query filters, see the :ref:`ruby-specify-query` guide.
- To view code examples of retrieving documents with the {+driver-short+}, see :ref:`ruby-read`.
+To learn more about query filters, see the :ref:`ruby-specify-query` guide.
+
+To view code examples that retrieve documents by using the {+driver-short+},
+see :ref:`ruby-read`.
 
 API Documentation
 ~~~~~~~~~~~~~~~~~
diff --git a/source/read/specify-documents-to-return.txt b/source/read/specify-documents-to-return.txt
@@ -201,7 +201,7 @@ Additional Information
 
 For more information about retrieving documents, see the :ref:`ruby-retrieve` guide.
 
-.. TODO: For more information about specifying a query, see the :ref:`ruby-specify-query` guide.
+For more information about specifying a query, see the :ref:`ruby-specify-query` guide.
 
 API Documentation
 ~~~~~~~~~~~~~~~~~
diff --git a/source/write/transactions.txt b/source/write/transactions.txt
@@ -109,13 +109,12 @@ actions:
 
 .. sharedinclude:: dbx/transactions-parallelism.rst
 
-    .. TODO:
-         Replace content to use this wording when the bulk write guide is added:
-    .. replacement:: driver-specific-content
-    ..   If you're using {+mdb-server+} v8.0 or later, you can perform
-    ..   write operations on multiple namespaces within a single transaction by using
-    ..   the ``bulk-write`` method. For more information, see the :ref:`<ruby-bulk-write>`
-    ..   guide.
+   .. replacement:: driver-specific-content
+    
+      If you're using {+mdb-server+} v8.0 or later, you can perform
+      write operations on multiple namespaces within a single transaction by using
+      the ``bulk_write`` method. For more information, see the :ref:`<ruby-bulk-write>`
+      guide.
 
 Additional Information
 ----------------------
