Skip to content

DOCSP-44951 TOC Relabel #144

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.

Sign up for GitHub

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

Merged
merged 3 commits into from
Nov 13, 2024
Merged

DOCSP-44951 TOC Relabel #144

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
1608add
DOCSP-44951 TOC Relabel
lindseymoore Nov 11, 2024
f2f8c0d
fixes
lindseymoore Nov 12, 2024
e411553
internal review changes
lindseymoore Nov 13, 2024
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
40 changes: 20 additions & 20 deletions source/fundamentals.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,26 +8,26 @@ Fundamentals
:titlesonly:
:maxdepth: 1

/fundamentals/connections
/fundamentals/stable-api
/fundamentals/authentication
/fundamentals/enterprise-auth
/fundamentals/crud
/fundamentals/serialization
/fundamentals/database-collection
/fundamentals/schema-validation
/fundamentals/aggregation
/fundamentals/indexes
/fundamentals/transactions
/fundamentals/time-series
/fundamentals/tracing-logging
/fundamentals/run-command
/fundamentals/performance
/fundamentals/runtimes
/fundamentals/monitoring
/fundamentals/collations
/fundamentals/geo
/fundamentals/gridfs
Connections </fundamentals/connections>
Stable API </fundamentals/stable-api>
Authentication </fundamentals/authentication>
Enterprise Authentication </fundamentals/enterprise-auth>
CRUD </fundamentals/crud>
Serialization </fundamentals/serialization>
Databases & Collections </fundamentals/database-collection>
Schema Validation </fundamentals/schema-validation>
Aggregation </fundamentals/aggregation>
Indexes </fundamentals/indexes>
Transactions </fundamentals/transactions>
Time Series Collections </fundamentals/time-series>
Tracing & Logging </fundamentals/tracing-logging>
Database Commands </fundamentals/run-command>
Performance Considerations </fundamentals/performance>
Async & Sync APIs </fundamentals/runtimes>
Monitoring </fundamentals/monitoring>
Collations </fundamentals/collations>
Search Geospatially </fundamentals/geo>
GridFS </fundamentals/gridfs>

..
Connect to MongoDB Atlas from AWS Lambda <https://www.mongodb.com/docs/atlas/manage-connections-aws-lambda/>
Expand Down
8 changes: 4 additions & 4 deletions source/fundamentals/connections.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,10 @@ Connections

.. toctree::

/fundamentals/connections/connection-guide
/fundamentals/connections/connection-options
/fundamentals/connections/network-compression
/fundamentals/connections/tls
Connection Guide </fundamentals/connections/connection-guide>
Connection Options </fundamentals/connections/connection-options>
Comment on lines +9 to +10
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Connection Guide </fundamentals/connections/connection-guide>
Connection Options </fundamentals/connections/connection-options>
Guide </fundamentals/connections/connection-guide>
Options </fundamentals/connections/connection-options>

Copy link
Collaborator Author

@lindseymoore lindseymoore Nov 12, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would prefer to leave because it fits on one line. My reasoning is to provide the context in the TOC where possible when it becomes a title as vague as "Options" or "Guide". Think it burdens the user with additional cognitive load when they need to refer to the parent section name for context.

Network Compression </fundamentals/connections/network-compression>
Enable & Configure TLS </fundamentals/connections/tls>

..
Connect to MongoDB Atlas from AWS Lambda <https://www.mongodb.com/docs/atlas/manage-connections-aws-lambda/>
Expand Down
6 changes: 3 additions & 3 deletions source/fundamentals/crud.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,9 @@ CRUD Operations
.. toctree::
:caption: CRUD Operations

/fundamentals/crud/read-operations
/fundamentals/crud/write-operations
/fundamentals/crud/compound-operations
Read </fundamentals/crud/read-operations>
Write </fundamentals/crud/write-operations>
Compound Operations </fundamentals/crud/compound-operations>

..
/fundamentals/crud/write-read-pref
Expand Down
16 changes: 8 additions & 8 deletions source/fundamentals/crud/read-operations.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,14 +7,14 @@ Read Operations
.. toctree::
:caption: Read Operations

/fundamentals/crud/read-operations/retrieve
/fundamentals/crud/read-operations/query
/fundamentals/crud/read-operations/cursor
/fundamentals/crud/read-operations/change-streams
/fundamentals/crud/read-operations/text-search
/fundamentals/crud/read-operations/sort
/fundamentals/crud/read-operations/skip
/fundamentals/crud/read-operations/limit
Retrieve Data </fundamentals/crud/read-operations/retrieve>
Specify a Query </fundamentals/crud/read-operations/query>
Data Cursors </fundamentals/crud/read-operations/cursor>
Open Change Streams </fundamentals/crud/read-operations/change-streams>
Search Text </fundamentals/crud/read-operations/text-search>
Sort Results </fundamentals/crud/read-operations/sort>
Skip Results </fundamentals/crud/read-operations/skip>
Limit Results </fundamentals/crud/read-operations/limit>

..
/fundamentals/crud/read-operations/count
Expand Down
8 changes: 4 additions & 4 deletions source/fundamentals/crud/write-operations.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,10 @@ Write Operations
.. toctree::
:caption: Write Operations

/fundamentals/crud/write-operations/insert
/fundamentals/crud/write-operations/change
/fundamentals/crud/write-operations/delete
/fundamentals/crud/write-operations/bulk
Insert </fundamentals/crud/write-operations/insert>
Modify </fundamentals/crud/write-operations/change>
Delete </fundamentals/crud/write-operations/delete>
Bulk Operations </fundamentals/crud/write-operations/bulk>

..
/fundamentals/crud/write-operations/arrays
Expand Down
2 changes: 1 addition & 1 deletion source/fundamentals/indexes.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ Indexes

.. toctree::

/fundamentals/indexes/atlas-search-indexes
Atlas Search Indexes </fundamentals/indexes/atlas-search-indexes>

Overview
--------
Expand Down
6 changes: 3 additions & 3 deletions source/fundamentals/monitoring.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,9 @@ Monitoring
.. toctree::
:caption: Monitoring categories

/fundamentals/monitoring/cluster-monitoring
/fundamentals/monitoring/command-monitoring
/fundamentals/monitoring/connection-monitoring
Cluster Monitoring </fundamentals/monitoring/cluster-monitoring>
Command Monitoring </fundamentals/monitoring/command-monitoring>
Connection Monitoring </fundamentals/monitoring/connection-monitoring>
Comment on lines +10 to +12
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Cluster Monitoring </fundamentals/monitoring/cluster-monitoring>
Command Monitoring </fundamentals/monitoring/command-monitoring>
Connection Monitoring </fundamentals/monitoring/connection-monitoring>
Cluster </fundamentals/monitoring/cluster-monitoring>
Command </fundamentals/monitoring/command-monitoring>
Connection </fundamentals/monitoring/connection-monitoring>

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

^same reasoning as above. Would prefer to leave.


- :ref:`Cluster Monitoring <rust-cluster-monitoring>`: monitor changes
in your cluster configuration
Expand Down
19 changes: 9 additions & 10 deletions source/index.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,19 +7,18 @@
:maxdepth: 1

Quick Start </quick-start>
/quick-reference
/whats-new
/usage-examples
/fundamentals
Quick Reference </quick-reference>
What's New </whats-new>
CRUD Examples </usage-examples>
Fundamentals </fundamentals>
API Documentation <{+api+}/>
/faq
/connection-troubleshooting
/op-error-handling
/issues-and-help
/compatibility
FAQ </faq>
Connection Troubleshooting </connection-troubleshooting>
Operation Error Handling </op-error-handling>
Comment on lines +16 to +17
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Connection Troubleshooting </connection-troubleshooting>
Operation Error Handling </op-error-handling>
Troubleshooting </connection-troubleshooting>
Error Handling </op-error-handling>

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would prefer to leave. "Trouble shooting" and "error handling" could be synonymous without the additional context.

Issues & Help </issues-and-help>
Compatibility </compatibility>
View the Source <https://github.com/mongodb/mongo-rust-driver>


Introduction
------------

Expand Down
16 changes: 8 additions & 8 deletions source/quick-start.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,14 @@ Rust Driver Quick Start
.. meta::
:keywords: get started, tutorial, code example

.. 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 </quick-start/connect-to-mongodb/>
Next Steps </quick-start/next-steps/>

Overview
--------

Expand All @@ -34,11 +42,3 @@ required) MongoDB Atlas deployment by following the steps in this guide.

Follow the steps in this guide to connect a sample Rust 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/
22 changes: 11 additions & 11 deletions source/usage-examples.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,17 +19,17 @@ Usage Examples

.. toctree::

/usage-examples/findOne
/usage-examples/find
/usage-examples/insertOne
/usage-examples/insertMany
/usage-examples/updateOne
/usage-examples/updateMany
/usage-examples/replace
/usage-examples/deleteOne
/usage-examples/deleteMany
/usage-examples/count
/usage-examples/distinct
Find One </usage-examples/findOne>
Find Multiple </usage-examples/find>
Insert One </usage-examples/insertOne>
Insert Multiple </usage-examples/insertMany>
Update One </usage-examples/updateOne>
Update Multiple </usage-examples/updateMany>
Replace One </usage-examples/replace>
Delete One </usage-examples/deleteOne>
Delete Multiple </usage-examples/deleteMany>
Count </usage-examples/count>
List Distinct Values </usage-examples/distinct>

Overview
--------
Expand Down
Loading