Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Backport v5.0] DOCSP-44902 Shorten TOC #595

Merged
merged 2 commits into from
Nov 25, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 26 additions & 0 deletions .github/workflows/backport.yml
Original file line number Diff line number Diff line change
@@ -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 }}
36 changes: 18 additions & 18 deletions source/fundamentals.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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
12 changes: 6 additions & 6 deletions source/fundamentals/builders.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
16 changes: 8 additions & 8 deletions source/fundamentals/connection.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
8 changes: 4 additions & 4 deletions source/fundamentals/crud.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
26 changes: 13 additions & 13 deletions source/fundamentals/crud/read-operations.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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`
Expand All @@ -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
20 changes: 10 additions & 10 deletions source/fundamentals/crud/write-operations.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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
24 changes: 11 additions & 13 deletions source/fundamentals/data-formats.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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


24 changes: 12 additions & 12 deletions source/index.txt
Original file line number Diff line number Diff line change
Expand Up @@ -18,18 +18,18 @@ 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
/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>
Migrate from the Legacy API </legacy>
View the Source <https://github.com/mongodb/mongo-java-driver>

Introduction
Expand Down
19 changes: 9 additions & 10 deletions source/usage-examples.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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
--------
Expand Down
11 changes: 5 additions & 6 deletions source/usage-examples/delete-operations.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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>`
10 changes: 5 additions & 5 deletions source/usage-examples/find-operations.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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>`
10 changes: 5 additions & 5 deletions source/usage-examples/insert-operations.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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>`
14 changes: 7 additions & 7 deletions source/usage-examples/update-operations.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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>`
Loading