Skip to content

Commit cca6453

Browse files
lindseymoorelindseymoore
authored
[Backport v5.0] DOCSP-44902 Shorten TOC (#595)
* [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) * backport workflow
1 parent 415b8ec commit cca6453

File tree

14 files changed

+139
-117
lines changed

14 files changed

+139
-117
lines changed

‎.github/workflows/backport.yml‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
name: Backport
2+
on:
3+
pull_request_target:
4+
types:
5+
- closed
6+
- labeled
7+
8+
jobs:
9+
backport:
10+
name: Backport
11+
runs-on: ubuntu-latest
12+
# Only react to merged PRs for security reasons.
13+
# See https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#pull_request_target.
14+
if: >
15+
github.event.pull_request.merged
16+
&& (
17+
github.event.action == 'closed'
18+
|| (
19+
github.event.action == 'labeled'
20+
&& contains(github.event.label.name, 'backport')
21+
)
22+
)
23+
steps:
24+
- uses: tibdex/backport@v2
25+
with:
26+
github_token: ${{ secrets.GITHUB_TOKEN }}

‎source/fundamentals.txt‎

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -9,23 +9,23 @@ Fundamentals
99
:titlesonly:
1010
:maxdepth: 1
1111

12-
/fundamentals/connection
13-
/fundamentals/auth
14-
/fundamentals/enterprise-auth
15-
/fundamentals/stable-api
16-
/fundamentals/databases-collections
17-
/fundamentals/data-formats
18-
/fundamentals/crud
19-
/fundamentals/builders
20-
/fundamentals/aggregation
21-
/fundamentals/aggregation-expression-operations
22-
/fundamentals/indexes
23-
/fundamentals/transactions
24-
/fundamentals/collations
25-
/fundamentals/logging
26-
/fundamentals/monitoring
27-
/fundamentals/gridfs
28-
/fundamentals/encrypt-fields
29-
/fundamentals/time-series
12+
Connection Guide </fundamentals/connection>
13+
Authentication </fundamentals/auth>
14+
Enterprise Authentication </fundamentals/enterprise-auth>
15+
Stable API </fundamentals/stable-api>
16+
Databases & Collections </fundamentals/databases-collections>
17+
Data Formats </fundamentals/data-formats>
18+
CRUD Operations </fundamentals/crud>
19+
Builders </fundamentals/builders>
20+
Aggregation </fundamentals/aggregation>
21+
Aggregation Expressions </fundamentals/aggregation-expression-operations>
22+
Indexes </fundamentals/indexes>
23+
Transactions </fundamentals/transactions>
24+
Collations </fundamentals/collations>
25+
Logging </fundamentals/logging>
26+
Monitoring </fundamentals/monitoring>
27+
GridFS </fundamentals/gridfs>
28+
In-Use Encryption </fundamentals/encrypt-fields>
29+
Time Series Collections </fundamentals/time-series>
3030

3131
.. include:: /includes/fundamentals-sections.rst

‎source/fundamentals/builders.txt‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -8,12 +8,12 @@ Builders
88

99
.. toctree::
1010

11-
/fundamentals/builders/aggregates
12-
/fundamentals/builders/filters
13-
/fundamentals/builders/indexes
14-
/fundamentals/builders/projections
15-
/fundamentals/builders/sort
16-
/fundamentals/builders/updates
11+
Aggregation </fundamentals/builders/aggregates>
12+
Filters </fundamentals/builders/filters>
13+
Indexes </fundamentals/builders/indexes>
14+
Projection </fundamentals/builders/projections>
15+
Sort </fundamentals/builders/sort>
16+
Update </fundamentals/builders/updates>
1717

1818
.. contents:: On this page
1919
:local:

‎source/fundamentals/connection.txt‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -6,14 +6,14 @@ Connection Guide
66

77
.. toctree::
88

9-
/fundamentals/connection/connect
10-
/fundamentals/connection/connection-options
11-
/fundamentals/connection/mongoclientsettings
12-
/fundamentals/connection/network-compression
13-
/fundamentals/connection/tls
14-
/fundamentals/connection/socks
15-
/fundamentals/connection/jndi
16-
Connect to MongoDB Atlas from AWS Lambda <https://www.mongodb.com/docs/atlas/manage-connections-aws-lambda/>
9+
Connect to MongoDB </fundamentals/connection/connect>
10+
Connection Options </fundamentals/connection/connection-options>
11+
MongoClient Settings </fundamentals/connection/mongoclientsettings>
12+
Network Compression </fundamentals/connection/network-compression>
13+
TLS/SSL </fundamentals/connection/tls>
14+
SOCKS5 Proxy </fundamentals/connection/socks>
15+
JNDI Datasource </fundamentals/connection/jndi>
16+
AWS Lambda <https://www.mongodb.com/docs/atlas/manage-connections-aws-lambda/>
1717

1818
.. contents:: On this page
1919
:local:

‎source/fundamentals/crud.txt‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,10 +9,10 @@ CRUD Operations
99
.. toctree::
1010
:caption: CRUD Operations
1111

12-
/fundamentals/crud/read-operations
13-
/fundamentals/crud/write-operations
14-
/fundamentals/crud/query-document
15-
/fundamentals/crud/compound-operations
12+
Read </fundamentals/crud/read-operations>
13+
Write </fundamentals/crud/write-operations>
14+
Query </fundamentals/crud/query-document>
15+
Compound Operations </fundamentals/crud/compound-operations>
1616

1717
CRUD (Create, Read, Update, Delete) operations enable you to work with
1818
data stored in MongoDB.

‎source/fundamentals/crud/read-operations.txt‎

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,19 @@ Read Operations
55
.. meta::
66
:description: Learn about the commands for running read operations on MongoDB by using the {+driver-long+}.
77

8+
.. toctree::
9+
:caption: Read Operations
10+
11+
Retrieve Data </fundamentals/crud/read-operations/retrieve>
12+
Data from a Cursor </fundamentals/crud/read-operations/cursor>
13+
Open Change Streams </fundamentals/crud/read-operations/change-streams>
14+
Sort Results </fundamentals/crud/read-operations/sort>
15+
Skip Returned Results </fundamentals/crud/read-operations/skip>
16+
Limit Returned Results </fundamentals/crud/read-operations/limit>
17+
Specify Fields to Return </fundamentals/crud/read-operations/project>
18+
Geospatial Data </fundamentals/crud/read-operations/geo>
19+
Search Text </fundamentals/crud/read-operations/text>
20+
821
- :doc:`/fundamentals/crud/read-operations/retrieve`
922
- :doc:`/fundamentals/crud/read-operations/cursor`
1023
- :doc:`/fundamentals/crud/read-operations/change-streams`
@@ -14,16 +27,3 @@ Read Operations
1427
- :doc:`/fundamentals/crud/read-operations/project`
1528
- :doc:`/fundamentals/crud/read-operations/geo`
1629
- :doc:`/fundamentals/crud/read-operations/text`
17-
18-
.. toctree::
19-
:caption: Read Operations
20-
21-
/fundamentals/crud/read-operations/retrieve
22-
/fundamentals/crud/read-operations/cursor
23-
/fundamentals/crud/read-operations/change-streams
24-
/fundamentals/crud/read-operations/sort
25-
/fundamentals/crud/read-operations/skip
26-
/fundamentals/crud/read-operations/limit
27-
/fundamentals/crud/read-operations/project
28-
/fundamentals/crud/read-operations/geo
29-
/fundamentals/crud/read-operations/text

‎source/fundamentals/crud/write-operations.txt‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -5,19 +5,19 @@ Write Operations
55
.. meta::
66
:description: Learn about the commands for running MongoDB write operations by using the {+driver-long+}.
77

8+
.. toctree::
9+
:caption: Write Operations
10+
11+
Insert </fundamentals/crud/write-operations/insert>
12+
Delete </fundamentals/crud/write-operations/delete>
13+
Modify </fundamentals/crud/write-operations/modify>
14+
Update Array Elements </fundamentals/crud/write-operations/embedded-arrays>
15+
Upsert </fundamentals/crud/write-operations/upsert>
16+
Bulk Operations </fundamentals/crud/write-operations/bulk>
17+
818
- :doc:`/fundamentals/crud/write-operations/insert`
919
- :doc:`/fundamentals/crud/write-operations/delete`
1020
- :doc:`/fundamentals/crud/write-operations/modify`
1121
- :doc:`/fundamentals/crud/write-operations/embedded-arrays`
1222
- :doc:`/fundamentals/crud/write-operations/upsert`
1323
- :doc:`/fundamentals/crud/write-operations/bulk`
14-
15-
.. toctree::
16-
:caption: Write Operations
17-
18-
/fundamentals/crud/write-operations/insert
19-
/fundamentals/crud/write-operations/delete
20-
/fundamentals/crud/write-operations/modify
21-
/fundamentals/crud/write-operations/embedded-arrays
22-
/fundamentals/crud/write-operations/upsert
23-
/fundamentals/crud/write-operations/bulk

‎source/fundamentals/data-formats.txt‎

Lines changed: 11 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -5,23 +5,21 @@ Data Formats
55
.. meta::
66
:description: Learn how to convert between MongoDB and Java data formats by using the {+driver-long+}.
77

8+
.. toctree::
9+
:caption: Data Formats
10+
11+
BSON </fundamentals/data-formats/document-data-format-bson>
12+
Extended JSON </fundamentals/data-formats/document-data-format-extended-json>
13+
Documents </fundamentals/data-formats/documents>
14+
POJOs </fundamentals/data-formats/document-data-format-pojo>
15+
Records </fundamentals/data-formats/document-data-format-record>
16+
POJO Customization </fundamentals/data-formats/pojo-customization>
17+
Codecs </fundamentals/data-formats/codecs>
18+
819
- :doc:`/fundamentals/data-formats/document-data-format-bson`
920
- :doc:`/fundamentals/data-formats/document-data-format-extended-json`
1021
- :doc:`/fundamentals/data-formats/documents`
1122
- :doc:`/fundamentals/data-formats/document-data-format-pojo`
1223
- :doc:`/fundamentals/data-formats/document-data-format-record`
1324
- :doc:`/fundamentals/data-formats/pojo-customization`
1425
- :doc:`/fundamentals/data-formats/codecs`
15-
16-
.. toctree::
17-
:caption: Data Formats
18-
19-
/fundamentals/data-formats/document-data-format-bson
20-
/fundamentals/data-formats/document-data-format-extended-json
21-
/fundamentals/data-formats/documents
22-
/fundamentals/data-formats/document-data-format-pojo
23-
/fundamentals/data-formats/document-data-format-record
24-
/fundamentals/data-formats/pojo-customization
25-
/fundamentals/data-formats/codecs
26-
27-

‎source/index.txt‎

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -18,18 +18,18 @@ MongoDB Java Driver
1818
:maxdepth: 1
1919

2020
Quick Start </quick-start>
21-
/quick-reference
22-
/whats-new
23-
/usage-examples
24-
/fundamentals
25-
/api-documentation
26-
/faq
27-
/connection-troubleshooting
28-
/issues-and-help
29-
/integrations
30-
/compatibility
31-
/upgrade
32-
/legacy
21+
Quick Reference </quick-reference>
22+
What's New </whats-new>
23+
Usage Examples </usage-examples>
24+
Fundamentals </fundamentals>
25+
API Documentation </api-documentation>
26+
FAQ </faq>
27+
Connection Troubleshooting </connection-troubleshooting>
28+
Issues & Help </issues-and-help>
29+
Driver Integrations </integrations>
30+
Compatibility </compatibility>
31+
Upgrade </upgrade>
32+
Migrate from the Legacy API </legacy>
3333
View the Source <https://github.com/mongodb/mongo-java-driver>
3434

3535
Introduction

‎source/usage-examples.txt‎

Lines changed: 9 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -12,16 +12,15 @@ Usage Examples
1212

1313
.. toctree::
1414

15-
/usage-examples/find-operations
16-
/usage-examples/insert-operations
17-
/usage-examples/update-operations
18-
/usage-examples/delete-operations
19-
/usage-examples/bulkWrite
20-
/usage-examples/watch
21-
/usage-examples/count
22-
/usage-examples/distinct
23-
/usage-examples/command
24-
15+
Find </usage-examples/find-operations>
16+
Insert </usage-examples/insert-operations>
17+
Update & Replace </usage-examples/update-operations>
18+
Delete </usage-examples/delete-operations>
19+
Bulk Operations </usage-examples/bulkWrite>
20+
Watch for Changes </usage-examples/watch>
21+
Count Documents </usage-examples/count>
22+
Distinct Field Values </usage-examples/distinct>
23+
Run a Command </usage-examples/command>
2524

2625
Overview
2726
--------

0 commit comments

Comments
 (0)