[Backport v6.7] DOCSP-44947 Shorten TOC (#932)

* DOCSP-44947 TOC Relabel (#923) * DOCSP-44947 TOC Relabel * font: * edit * Mike's suggestion (cherry picked from commit 09afc55) * backport
mongodb · Nov 23, 2024 · 6159bc4 · 6159bc4
1 parent 146996e
commit 6159bc4
Show file tree

Hide file tree

Showing 18 changed files with 144 additions and 120 deletions.
diff --git a/.github/workflows/backport.yml b/.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 }}
diff --git a/source/aggregation-tutorials.txt b/source/aggregation-tutorials.txt
@@ -19,11 +19,11 @@ Aggregation Tutorials
 
 .. toctree::
 
-   /aggregation-tutorials/filtered-subset/
-   /aggregation-tutorials/group-total/
-   /aggregation-tutorials/unpack-arrays/
-   /aggregation-tutorials/one-to-one-join/
-   /aggregation-tutorials/multi-field-join/
+   Filtered Subset </aggregation-tutorials/filtered-subset/>
+   Group & Total </aggregation-tutorials/group-total/>
+   Unpack Arrays & Group </aggregation-tutorials/unpack-arrays/>
+   One-to-One Join </aggregation-tutorials/one-to-one-join/>
+   Multi-Field Join </aggregation-tutorials/multi-field-join/>
 
 Overview
 --------

diff --git a/source/fundamentals.txt b/source/fundamentals.txt
@@ -6,22 +6,22 @@ Fundamentals
 
 .. toctree::
 
-   /fundamentals/connection
-   /fundamentals/stable-api
-   /fundamentals/authentication
-   /fundamentals/crud
-   /fundamentals/promises
-   /fundamentals/aggregation
-   /fundamentals/transactions
-   /fundamentals/run-command
-   /fundamentals/indexes
-   /fundamentals/collations
-   /fundamentals/logging
-   /fundamentals/monitoring
-   /fundamentals/gridfs
-   /fundamentals/time-series
-   /fundamentals/typescript
-   /fundamentals/bson
-   /fundamentals/encrypt-fields
+   Connection </fundamentals/connection>
+   Stable API </fundamentals/stable-api>
+   Authentication </fundamentals/authentication>
+   CRUD Operations </fundamentals/crud>
+   Promises </fundamentals/promises>
+   Aggregation </fundamentals/aggregation>
+   Transactions </fundamentals/transactions>
+   Run a Command </fundamentals/run-command>
+   Indexes </fundamentals/indexes>
+   Collations </fundamentals/collations>
+   Logging </fundamentals/logging>
+   Monitoring </fundamentals/monitoring>
+   GridFS </fundamentals/gridfs>
+   Time Series </fundamentals/time-series>
+   TypeScript </fundamentals/typescript>
+   BSON Settings </fundamentals/bson>
+   In-Use Encryption </fundamentals/encrypt-fields>
 
 .. include:: /includes/fundamentals-sections.rst
diff --git a/source/fundamentals/authentication.txt b/source/fundamentals/authentication.txt
@@ -8,8 +8,8 @@ Authentication
 
 .. toctree::
 
-   /fundamentals/authentication/mechanisms
-   /fundamentals/authentication/enterprise-mechanisms
+   Authentication </fundamentals/authentication/mechanisms>
+   Enterprise Authentication </fundamentals/authentication/enterprise-mechanisms>
 
 Overview
 --------

diff --git a/source/fundamentals/bson.txt b/source/fundamentals/bson.txt
@@ -7,8 +7,8 @@ BSON Settings
 .. toctree::
    :caption: BSON settings
 
-   /fundamentals/bson/undefined-values
-   /fundamentals/bson/utf8-validation
+   Undefined Values </fundamentals/bson/undefined-values>
+   UTF-8 Validation </fundamentals/bson/utf8-validation>
 
 .. contents:: On this page
    :local:

diff --git a/source/fundamentals/connection.txt b/source/fundamentals/connection.txt
@@ -16,12 +16,12 @@ Connection
 
 .. toctree::
 
-   /fundamentals/connection/connect
-   /fundamentals/connection/connection-options
-   /fundamentals/connection/network-compression
-   /fundamentals/connection/tls
-   /fundamentals/connection/socks
-   Connect to MongoDB Atlas from AWS Lambda <https://www.mongodb.com/docs/atlas/manage-connections-aws-lambda/>
+   Connection Guide </fundamentals/connection/connect>
+   Connection Options </fundamentals/connection/connection-options>
+   Network Compression </fundamentals/connection/network-compression>
+   TLS </fundamentals/connection/tls>
+   SOCKS5 Proxy Support </fundamentals/connection/socks>
+   Connect with AWS Lambda <https://www.mongodb.com/docs/atlas/manage-connections-aws-lambda/>
 
 .. contents:: On this page
    :local:

diff --git a/source/fundamentals/crud.txt b/source/fundamentals/crud.txt
@@ -15,11 +15,11 @@ CRUD Operations
 .. toctree::
    :caption: CRUD Operations
 
-   /fundamentals/crud/read-operations
-   /fundamentals/crud/write-operations
-   /fundamentals/crud/query-document
-   /fundamentals/crud/compound-operations
-   /fundamentals/crud/read-write-pref
+   Read </fundamentals/crud/read-operations>
+   Write </fundamentals/crud/write-operations>
+   Query </fundamentals/crud/query-document>
+   Compound Operations </fundamentals/crud/compound-operations>
+   Operations on Replica Sets </fundamentals/crud/read-write-pref>
 
 CRUD (Create, Read, Update, Delete) operations allow you to work with
 the data stored in MongoDB.

diff --git a/source/fundamentals/crud/read-operations.txt b/source/fundamentals/crud/read-operations.txt
@@ -14,6 +14,19 @@ Read Operations
 .. meta:: 
    :keywords: code example, node.js, sample dataset
 
+.. toctree::
+   :caption: Read Operations
+
+   Retrieve Data </fundamentals/crud/read-operations/retrieve>
+   Access Data from a Cursor </fundamentals/crud/read-operations/cursor>
+   Distinct Values </fundamentals/crud/read-operations/distinct>
+   Sort Results </fundamentals/crud/read-operations/sort>
+   Skip Returned Results </fundamentals/crud/read-operations/skip>
+   Limit Returned Results </fundamentals/crud/read-operations/limit>
+   Specify Fields to Return </fundamentals/crud/read-operations/project>
+   Search Geospatially </fundamentals/crud/read-operations/geo>
+   Search Text </fundamentals/crud/read-operations/text>
+
 - :doc:`/fundamentals/crud/read-operations/retrieve`
 - :doc:`/fundamentals/crud/read-operations/cursor`
 - :doc:`/fundamentals/crud/read-operations/distinct`
@@ -23,16 +36,3 @@ Read Operations
 - :doc:`/fundamentals/crud/read-operations/project`
 - :doc:`/fundamentals/crud/read-operations/geo`
 - :doc:`/fundamentals/crud/read-operations/text`
-
-.. toctree::
-   :caption: Read Operations
-
-   /fundamentals/crud/read-operations/retrieve
-   /fundamentals/crud/read-operations/cursor
-   /fundamentals/crud/read-operations/distinct
-   /fundamentals/crud/read-operations/sort
-   /fundamentals/crud/read-operations/skip
-   /fundamentals/crud/read-operations/limit
-   /fundamentals/crud/read-operations/project
-   /fundamentals/crud/read-operations/geo
-   /fundamentals/crud/read-operations/text
diff --git a/source/fundamentals/crud/write-operations.txt b/source/fundamentals/crud/write-operations.txt
@@ -5,20 +5,20 @@ Write Operations
 .. meta::
    :description: Learn about the commands for running MongoDB write operations by using the {+driver-long+}.
 
+
+.. toctree::
+   :caption: Write Operations
+
+   Insert </fundamentals/crud/write-operations/insert>
+   Custom Values for _id </fundamentals/crud/write-operations/pkFactory>
+   Delete </fundamentals/crud/write-operations/delete>
+   Modify </fundamentals/crud/write-operations/modify>
+   Update Arrays </fundamentals/crud/write-operations/embedded-arrays>
+   Upsert </fundamentals/crud/write-operations/upsert>
+
 - :doc:`/fundamentals/crud/write-operations/insert`
 - :doc:`/fundamentals/crud/write-operations/pkFactory`
 - :doc:`/fundamentals/crud/write-operations/delete`
 - :doc:`/fundamentals/crud/write-operations/modify`
 - :doc:`/fundamentals/crud/write-operations/embedded-arrays`
 - :doc:`/fundamentals/crud/write-operations/upsert`
-
-.. toctree::
-   :caption: Write Operations
-
-   /fundamentals/crud/write-operations/insert
-   /fundamentals/crud/write-operations/pkFactory
-   /fundamentals/crud/write-operations/delete
-   /fundamentals/crud/write-operations/modify
-   /fundamentals/crud/write-operations/embedded-arrays
-   /fundamentals/crud/write-operations/upsert
-
diff --git a/source/fundamentals/monitoring.txt b/source/fundamentals/monitoring.txt
@@ -9,9 +9,9 @@ Monitoring
 .. toctree::
    :caption: CRUD Operations
 
-   /fundamentals/monitoring/cluster-monitoring
-   /fundamentals/monitoring/command-monitoring
-   /fundamentals/monitoring/connection-monitoring
+   Clusters  </fundamentals/monitoring/cluster-monitoring>
+   Commands </fundamentals/monitoring/command-monitoring>
+   Connection Pool </fundamentals/monitoring/connection-monitoring>
 
 - :doc:`Cluster Monitoring </fundamentals/monitoring/cluster-monitoring>`: monitoring
   changes in a cluster

diff --git a/source/index.txt b/source/index.txt
@@ -17,17 +17,17 @@ MongoDB Node Driver
   :maxdepth: 1
 
   Quick Start </quick-start>
-  /quick-reference
-  /whats-new
-  /usage-examples
-  /fundamentals
-  /aggregation-tutorials
+  Quick Reference </quick-reference>
+  What's New </whats-new>
+  Usage Examples </usage-examples>
+  Fundamentals </fundamentals>
+  Aggregation Tutorials </aggregation-tutorials>
   API Documentation <{+api+}>
-  /faq
-  /connection-troubleshooting
-  /issues-and-help
-  /compatibility
-  /upgrade
+  FAQ </faq>
+  Connection Troubleshooting </connection-troubleshooting>
+  Issues & Help </issues-and-help>
+  Compatibility </compatibility>
+  Upgrade </upgrade>
   Release Notes <https://github.com/mongodb/node-mongodb-native/releases/>
   View the Source <https://github.com/mongodb/node-mongodb-native/>
 

diff --git a/source/quick-start.txt b/source/quick-start.txt
@@ -18,6 +18,14 @@ Node Driver Quick Start
    :depth: 1
    :class: singlecol
 
+.. toctree::
+
+   Download & Install </quick-start/download-and-install/>
+   Create a Deployment </quick-start/create-a-deployment/>
+   Create a Connection String </quick-start/create-a-connection-string/>
+   Connect to MongoDB </quick-start/connect-to-mongodb/>
+   Next Steps </quick-start/next-steps/>
+
 Overview
 --------
 
@@ -35,11 +43,3 @@ required) MongoDB Atlas deployment by following the steps in this guide.
 
 Follow the steps in this guide to connect a sample Node.js application to
 a MongoDB Atlas deployment.
-
-.. toctree::
-
-   /quick-start/download-and-install/
-   /quick-start/create-a-deployment/
-   /quick-start/create-a-connection-string/
-   /quick-start/connect-to-mongodb/
-   /quick-start/next-steps/
diff --git a/source/usage-examples.txt b/source/usage-examples.txt
@@ -20,16 +20,16 @@ Usage Examples
 
 .. toctree::
 
-   /usage-examples/find-operations
-   /usage-examples/insert-operations
-   /usage-examples/update-and-replace-operations
-   /usage-examples/delete-operations
-   /usage-examples/count
-   /usage-examples/distinct
-   /usage-examples/command
-   /usage-examples/changeStream
-   /usage-examples/bulkWrite
-   /usage-examples/transactions
+   Find </usage-examples/find-operations>
+   Insert </usage-examples/insert-operations>
+   Update & Replace </usage-examples/update-and-replace-operations>
+   Delete </usage-examples/delete-operations>
+   Count Documents </usage-examples/count>
+   Distinct Field Values </usage-examples/distinct>
+   Run a Command </usage-examples/command>
+   Watch for Changes </usage-examples/changeStream>
+   Bulk Operations </usage-examples/bulkWrite>
+   Perform a Transaction </usage-examples/transactions>
 
 Overview
 --------

diff --git a/source/usage-examples/delete-operations.txt b/source/usage-examples/delete-operations.txt
@@ -4,13 +4,12 @@ Delete Operations
 
 .. default-domain:: mongodb
 
-- :doc:`Delete a Document </usage-examples/deleteOne>`
-
-- :doc:`Delete Multiple Documents </usage-examples/deleteMany>`
-
 .. toctree::
    :caption: Examples
 
-   /usage-examples/deleteOne
-   /usage-examples/deleteMany
+   Delete a Document </usage-examples/deleteOne>
+   Delete Multiple Documents </usage-examples/deleteMany>
 
+- :doc:`Delete a Document </usage-examples/deleteOne>`
+
+- :doc:`Delete Multiple Documents </usage-examples/deleteMany>`
diff --git a/source/usage-examples/find-operations.txt b/source/usage-examples/find-operations.txt
@@ -5,12 +5,12 @@ Find Operations
 .. meta::
    :description: Learn by example: how to create queries and retrieve data from MongoDB by using the {+driver-long+}.
 
-- :doc:`Find a Document </usage-examples/findOne>`
-
-- :doc:`Find Multiple Documents </usage-examples/find>`
-
 .. toctree::
    :caption: Examples
 
-   /usage-examples/findOne
-   /usage-examples/find
+   Find a Document </usage-examples/findOne>
+   Find Multiple Documents </usage-examples/find>
+
+- :doc:`Find a Document </usage-examples/findOne>`
+
+- :doc:`Find Multiple Documents </usage-examples/find>`
diff --git a/source/usage-examples/insert-operations.txt b/source/usage-examples/insert-operations.txt
@@ -5,13 +5,12 @@ Insert Operations
 .. meta::
    :description: Learn by example: how to insert data into MongoDB by using the {+driver-long+}.
 
-- :doc:`Insert a Document </usage-examples/insertOne>`
-
-- :doc:`Insert Multiple Documents </usage-examples/insertMany>`
-
-
 .. toctree::
    :caption: Examples
 
-   /usage-examples/insertOne
-   /usage-examples/insertMany
+   Insert a Document </usage-examples/insertOne>
+   Insert Multiple Documents </usage-examples/insertMany>
+
+- :doc:`Insert a Document </usage-examples/insertOne>`
+
+- :doc:`Insert Multiple Documents </usage-examples/insertMany>`
diff --git a/source/usage-examples/transactions.txt b/source/usage-examples/transactions.txt
@@ -7,8 +7,8 @@ Perform a Transaction
 .. toctree::
    :caption: Transaction Usage Examples
 
-   /usage-examples/transaction-conv
-   /usage-examples/transaction-core
+   Convenient Transaction API </usage-examples/transaction-conv>
+   Core API </usage-examples/transaction-core>
 
 The following usage examples demonstrate how to perform transactions by
 using the transaction APIs in the {+driver-short+}:

diff --git a/source/usage-examples/update-and-replace-operations.txt b/source/usage-examples/update-and-replace-operations.txt
@@ -5,15 +5,15 @@ Update & Replace Operations
 .. meta::
    :description: Learn by example: how to update and replace data in MongoDB by using the {+driver-long+}.
 
+.. toctree::
+   :caption: Examples
+
+   Update a Document </usage-examples/updateOne>
+   Update Multiple Documents </usage-examples/updateMany>
+   Replace a Document </usage-examples/replaceOne>
+
 - :doc:`Update a Document </usage-examples/updateOne>`
 
 - :doc:`Update Multiple Documents </usage-examples/updateMany>`
 
 - :doc:`Replace a Document </usage-examples/replaceOne>`
-
-.. toctree::
-   :caption: Examples
-
-   /usage-examples/updateOne
-   /usage-examples/updateMany
-   /usage-examples/replaceOne