[Backport v5.1] DOCSP-44901 Shorten TOC (#594)

* [Backport v5.2] DOCSP-44901 TOC Relabel (#593) * delete 'one/many' changes (cherry picked from commit b9819b0) * DOCSP-44901 TOC Relabel (cherry picked from commit c08fb6c) * remaining changes * add back page bullets (cherry picked from commit 418963b) * include backport
mongodb · Nov 25, 2024 · 1033e75 · 1033e75
1 parent ffe51a0
commit 1033e75
Show file tree

Hide file tree

Showing 14 changed files with 140 additions and 118 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/fundamentals.txt b/source/fundamentals.txt
@@ -9,23 +9,23 @@ Fundamentals
    :titlesonly:
    :maxdepth: 1
 
-   /fundamentals/connection
-   /fundamentals/auth
-   /fundamentals/enterprise-auth
-   /fundamentals/stable-api
-   /fundamentals/databases-collections
-   /fundamentals/data-formats
-   /fundamentals/crud
-   /fundamentals/builders
-   /fundamentals/aggregation
-   /fundamentals/aggregation-expression-operations
-   /fundamentals/indexes
-   /fundamentals/transactions
-   /fundamentals/collations
-   /fundamentals/logging
-   /fundamentals/monitoring
-   /fundamentals/gridfs
-   /fundamentals/encrypt-fields
-   /fundamentals/time-series
+   Connection Guide </fundamentals/connection>
+   Authentication </fundamentals/auth>
+   Enterprise Authentication </fundamentals/enterprise-auth>
+   Stable API </fundamentals/stable-api>
+   Databases & Collections </fundamentals/databases-collections>
+   Data Formats </fundamentals/data-formats>
+   CRUD Operations </fundamentals/crud>
+   Builders </fundamentals/builders>
+   Aggregation </fundamentals/aggregation>
+   Aggregation Expressions </fundamentals/aggregation-expression-operations>
+   Indexes </fundamentals/indexes>
+   Transactions </fundamentals/transactions>
+   Collations </fundamentals/collations>
+   Logging </fundamentals/logging>
+   Monitoring </fundamentals/monitoring>
+   GridFS </fundamentals/gridfs>
+   In-Use Encryption </fundamentals/encrypt-fields>
+   Time Series Collections </fundamentals/time-series>
 
 .. include:: /includes/fundamentals-sections.rst
diff --git a/source/fundamentals/builders.txt b/source/fundamentals/builders.txt
@@ -8,12 +8,12 @@ Builders
 
 .. toctree::
 
-   /fundamentals/builders/aggregates
-   /fundamentals/builders/filters
-   /fundamentals/builders/indexes
-   /fundamentals/builders/projections
-   /fundamentals/builders/sort
-   /fundamentals/builders/updates
+   Aggregation </fundamentals/builders/aggregates>
+   Filters </fundamentals/builders/filters>
+   Indexes </fundamentals/builders/indexes>
+   Projection </fundamentals/builders/projections>
+   Sort </fundamentals/builders/sort>
+   Update </fundamentals/builders/updates>
 
 .. contents:: On this page
    :local:

diff --git a/source/fundamentals/connection.txt b/source/fundamentals/connection.txt
@@ -6,14 +6,14 @@ Connection Guide
 
 .. toctree::
 
-   /fundamentals/connection/connect
-   /fundamentals/connection/connection-options
-   /fundamentals/connection/mongoclientsettings
-   /fundamentals/connection/network-compression
-   /fundamentals/connection/tls
-   /fundamentals/connection/socks
-   /fundamentals/connection/jndi
-   Connect to MongoDB Atlas from AWS Lambda <https://www.mongodb.com/docs/atlas/manage-connections-aws-lambda/>
+   Connect to MongoDB </fundamentals/connection/connect>
+   Connection Options </fundamentals/connection/connection-options>
+   MongoClient Settings </fundamentals/connection/mongoclientsettings>
+   Network Compression </fundamentals/connection/network-compression>
+   TLS/SSL </fundamentals/connection/tls>
+   SOCKS5 Proxy </fundamentals/connection/socks>
+   JNDI Datasource </fundamentals/connection/jndi>
+   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
@@ -9,10 +9,10 @@ CRUD Operations
 .. toctree::
    :caption: CRUD Operations
 
-   /fundamentals/crud/read-operations
-   /fundamentals/crud/write-operations
-   /fundamentals/crud/query-document
-   /fundamentals/crud/compound-operations
+   Read </fundamentals/crud/read-operations>
+   Write </fundamentals/crud/write-operations>
+   Query </fundamentals/crud/query-document>
+   Compound Operations </fundamentals/crud/compound-operations>
 
 CRUD (Create, Read, Update, Delete) operations enable you to work with
 data stored in MongoDB.

diff --git a/source/fundamentals/crud/read-operations.txt b/source/fundamentals/crud/read-operations.txt
@@ -5,6 +5,19 @@ Read Operations
 .. meta::
    :description: Learn about the commands for running read operations on MongoDB by using the {+driver-long+}.
 
+.. toctree::
+   :caption: Read Operations
+
+   Retrieve Data </fundamentals/crud/read-operations/retrieve>
+   Data from a Cursor </fundamentals/crud/read-operations/cursor>
+   Open Change Streams </fundamentals/crud/read-operations/change-streams>
+   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>
+   Geospatial Data </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/change-streams`
@@ -14,16 +27,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/change-streams
-   /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,19 +5,19 @@ 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>
+   Delete </fundamentals/crud/write-operations/delete>
+   Modify </fundamentals/crud/write-operations/modify>
+   Update Array Elements </fundamentals/crud/write-operations/embedded-arrays>
+   Upsert </fundamentals/crud/write-operations/upsert>
+   Bulk Operations </fundamentals/crud/write-operations/bulk>
+
 - :doc:`/fundamentals/crud/write-operations/insert`
 - :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`
 - :doc:`/fundamentals/crud/write-operations/bulk`
-
-.. toctree::
-   :caption: Write Operations
-
-   /fundamentals/crud/write-operations/insert
-   /fundamentals/crud/write-operations/delete
-   /fundamentals/crud/write-operations/modify
-   /fundamentals/crud/write-operations/embedded-arrays
-   /fundamentals/crud/write-operations/upsert
-   /fundamentals/crud/write-operations/bulk
diff --git a/source/fundamentals/data-formats.txt b/source/fundamentals/data-formats.txt
@@ -5,23 +5,21 @@ Data Formats
 .. meta::
    :description: Learn how to convert between MongoDB and Java data formats by using the {+driver-long+}.
 
+.. toctree::
+   :caption: Data Formats
+
+   BSON </fundamentals/data-formats/document-data-format-bson>
+   Extended JSON </fundamentals/data-formats/document-data-format-extended-json>
+   Documents </fundamentals/data-formats/documents>
+   POJOs </fundamentals/data-formats/document-data-format-pojo>
+   Records </fundamentals/data-formats/document-data-format-record>
+   POJO Customization </fundamentals/data-formats/pojo-customization>
+   Codecs </fundamentals/data-formats/codecs>
+
 - :doc:`/fundamentals/data-formats/document-data-format-bson`
 - :doc:`/fundamentals/data-formats/document-data-format-extended-json`
 - :doc:`/fundamentals/data-formats/documents`
 - :doc:`/fundamentals/data-formats/document-data-format-pojo`
 - :doc:`/fundamentals/data-formats/document-data-format-record`
 - :doc:`/fundamentals/data-formats/pojo-customization`
 - :doc:`/fundamentals/data-formats/codecs`
-
-.. toctree::
-   :caption: Data Formats
-
-   /fundamentals/data-formats/document-data-format-bson
-   /fundamentals/data-formats/document-data-format-extended-json
-   /fundamentals/data-formats/documents
-   /fundamentals/data-formats/document-data-format-pojo
-   /fundamentals/data-formats/document-data-format-record
-   /fundamentals/data-formats/pojo-customization
-   /fundamentals/data-formats/codecs
-
-
diff --git a/source/index.txt b/source/index.txt
@@ -19,19 +19,19 @@ MongoDB Java Driver
    :maxdepth: 1
 
    Quick Start </quick-start>
-   /quick-reference
-   /whats-new
-   /usage-examples
-   /fundamentals
-   /api-documentation
-   /faq
-   /connection-troubleshooting
-   /issues-and-help
-   /integrations
-   /compatibility
-   /upgrade
-   /validate-signatures
-   /legacy
+   Quick Reference </quick-reference>
+   What's New </whats-new>
+   Usage Examples </usage-examples>
+   Fundamentals </fundamentals>
+   API Documentation </api-documentation>
+   FAQ </faq>
+   Connection Troubleshooting </connection-troubleshooting>
+   Issues & Help </issues-and-help>
+   Driver Integrations </integrations>
+   Compatibility </compatibility>
+   Upgrade </upgrade>
+   Validate Driver Signatures </validate-signatures>
+   Migrate from the Legacy API </legacy>
    View the Source <https://github.com/mongodb/mongo-java-driver>
 
 Introduction

diff --git a/source/usage-examples.txt b/source/usage-examples.txt
@@ -12,16 +12,15 @@ Usage Examples
 
 .. toctree::
 
-   /usage-examples/find-operations
-   /usage-examples/insert-operations
-   /usage-examples/update-operations
-   /usage-examples/delete-operations
-   /usage-examples/bulkWrite
-   /usage-examples/watch
-   /usage-examples/count
-   /usage-examples/distinct
-   /usage-examples/command
-
+   Find </usage-examples/find-operations>
+   Insert </usage-examples/insert-operations>
+   Update & Replace </usage-examples/update-operations>
+   Delete </usage-examples/delete-operations>
+   Bulk Operations </usage-examples/bulkWrite>
+   Watch for Changes </usage-examples/watch>
+   Count Documents </usage-examples/count>
+   Distinct Field Values </usage-examples/distinct>
+   Run a Command </usage-examples/command>
 
 Overview
 --------

diff --git a/source/usage-examples/delete-operations.txt b/source/usage-examples/delete-operations.txt
@@ -5,12 +5,11 @@ Delete Operations
 .. meta::
    :description: Learn by example: how to delete data from MongoDB by using the {+driver-long+}.
 
-- :doc:`Delete a Document </usage-examples/deleteOne>`
-- :doc:`Delete Multiple Documents </usage-examples/deleteMany>`
-
 .. toctree::
    :caption: Examples
 
-   /usage-examples/deleteOne
-   /usage-examples/deleteMany
-
+   Delete One </usage-examples/deleteOne>
+   Delete Many </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,11 +5,11 @@ 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 One </usage-examples/findOne>
+   Find Many </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,11 +5,11 @@ 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 One </usage-examples/insertOne>
+   Insert Many </usage-examples/insertMany>
+
+- :doc:`Insert a Document </usage-examples/insertOne>`
+- :doc:`Insert Multiple Documents </usage-examples/insertMany>`
diff --git a/source/usage-examples/update-operations.txt b/source/usage-examples/update-operations.txt
@@ -5,13 +5,13 @@ Update & Replace Operations
 .. meta::
    :description: Learn by example: how to update and replace data in MongoDB by using the {+driver-long+}.
 
-- :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
+   Update One </usage-examples/updateOne>
+   Update Many </usage-examples/updateMany>
+   Replace One </usage-examples/replaceOne>
+
+- :doc:`Update a Document </usage-examples/updateOne>`
+- :doc:`Update Multiple Documents </usage-examples/updateMany>`
+- :doc:`Replace a Document </usage-examples/replaceOne>`