From 1608add6113e6e267179d31c2e27680b35ed2da0 Mon Sep 17 00:00:00 2001 From: Lindsey Moore Date: Mon, 11 Nov 2024 18:23:43 -0500 Subject: [PATCH 1/3] DOCSP-44951 TOC Relabel --- source/fundamentals.txt | 40 +++++++++---------- source/fundamentals/connections.txt | 8 ++-- source/fundamentals/crud.txt | 6 +-- source/fundamentals/crud/read-operations.txt | 16 ++++---- source/fundamentals/crud/write-operations.txt | 8 ++-- source/fundamentals/indexes.txt | 2 +- source/fundamentals/monitoring.txt | 6 +-- source/index.txt | 19 +++++---- source/quick-start.txt | 16 ++++---- source/usage-examples.txt | 22 +++++----- 10 files changed, 71 insertions(+), 72 deletions(-) diff --git a/source/fundamentals.txt b/source/fundamentals.txt index f99fd564..68cfeda0 100644 --- a/source/fundamentals.txt +++ b/source/fundamentals.txt @@ -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 + Stable API + Authentication + Enterprise Authentication + CRUD + Serialization + Databases & Collections + Schema Validation + Aggregation + Indexes + Transactions + Time Series Collections + Tracing & Logging + Run a Command + Performance Considerations + Async & Sync APIs + Monitoring + Collations + Search Geospatially + GridFS .. Connect to MongoDB Atlas from AWS Lambda diff --git a/source/fundamentals/connections.txt b/source/fundamentals/connections.txt index bcceefb0..b9fc7736 100644 --- a/source/fundamentals/connections.txt +++ b/source/fundamentals/connections.txt @@ -6,10 +6,10 @@ Connections .. toctree:: - /fundamentals/connections/connection-guide - /fundamentals/connections/connection-options - /fundamentals/connections/network-compression - /fundamentals/connections/tls + Connection Guide + Connection Options + Network Compression + Enable & Configure TLS .. Connect to MongoDB Atlas from AWS Lambda diff --git a/source/fundamentals/crud.txt b/source/fundamentals/crud.txt index 53714a77..e21a4660 100644 --- a/source/fundamentals/crud.txt +++ b/source/fundamentals/crud.txt @@ -7,9 +7,9 @@ CRUD Operations .. toctree:: :caption: CRUD Operations - /fundamentals/crud/read-operations - /fundamentals/crud/write-operations - /fundamentals/crud/compound-operations + Read + Write + Compound Operations .. /fundamentals/crud/write-read-pref diff --git a/source/fundamentals/crud/read-operations.txt b/source/fundamentals/crud/read-operations.txt index 6f266216..a836b1be 100644 --- a/source/fundamentals/crud/read-operations.txt +++ b/source/fundamentals/crud/read-operations.txt @@ -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 + Specify a Query + Data from a Cursor + Open Change Streams + Search Text + Sort Results + Skip Returned Results + Limit Returned Results .. /fundamentals/crud/read-operations/count diff --git a/source/fundamentals/crud/write-operations.txt b/source/fundamentals/crud/write-operations.txt index fc006b2c..9746641e 100644 --- a/source/fundamentals/crud/write-operations.txt +++ b/source/fundamentals/crud/write-operations.txt @@ -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 + Modify + Delete + Bulk Operations .. /fundamentals/crud/write-operations/arrays diff --git a/source/fundamentals/indexes.txt b/source/fundamentals/indexes.txt index de804c16..c8b7f8b2 100644 --- a/source/fundamentals/indexes.txt +++ b/source/fundamentals/indexes.txt @@ -19,7 +19,7 @@ Indexes .. toctree:: - /fundamentals/indexes/atlas-search-indexes + Atlas Search Indexes Overview -------- diff --git a/source/fundamentals/monitoring.txt b/source/fundamentals/monitoring.txt index f01ef4da..f5668d34 100644 --- a/source/fundamentals/monitoring.txt +++ b/source/fundamentals/monitoring.txt @@ -7,9 +7,9 @@ Monitoring .. toctree:: :caption: Monitoring categories - /fundamentals/monitoring/cluster-monitoring - /fundamentals/monitoring/command-monitoring - /fundamentals/monitoring/connection-monitoring + Cluster Monitoring + Command Monitoring + Connection Monitoring - :ref:`Cluster Monitoring `: monitor changes in your cluster configuration diff --git a/source/index.txt b/source/index.txt index a8baab74..fdc5c220 100644 --- a/source/index.txt +++ b/source/index.txt @@ -7,19 +7,18 @@ :maxdepth: 1 Quick Start - /quick-reference - /whats-new - /usage-examples - /fundamentals + Quick Reference + What's New + Usage Examples + Fundamentals API Documentation <{+api+}/> - /faq - /connection-troubleshooting - /op-error-handling - /issues-and-help - /compatibility + FAQ + Connection Troubleshooting + Operation Error Handling + Issues & Help + Compatibility View the Source - Introduction ------------ diff --git a/source/quick-start.txt b/source/quick-start.txt index 15d8484f..72831697 100644 --- a/source/quick-start.txt +++ b/source/quick-start.txt @@ -17,6 +17,14 @@ Rust Driver Quick Start .. meta:: :keywords: get started, tutorial, code example +.. toctree:: + + Download & Install + Create a MongDB Deployment + Create a Connection String + Connect to MongoDB + Next Steps + Overview -------- @@ -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/ \ No newline at end of file diff --git a/source/usage-examples.txt b/source/usage-examples.txt index 78815a28..c887c7d5 100644 --- a/source/usage-examples.txt +++ b/source/usage-examples.txt @@ -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 a Document + Find Multiple Documents + Insert a Document + Insert Multiple Documents + Update a Document + Update Multiple Documents + Update a Document + Update Multiple Documents + Replace a Document + Count Documents + List Distinct Field Values Overview -------- From f2f8c0d60c69752afdac2a5301ef41e5fb11b747 Mon Sep 17 00:00:00 2001 From: Lindsey Moore Date: Mon, 11 Nov 2024 19:04:49 -0500 Subject: [PATCH 2/3] fixes --- source/usage-examples.txt | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/source/usage-examples.txt b/source/usage-examples.txt index c887c7d5..971a484f 100644 --- a/source/usage-examples.txt +++ b/source/usage-examples.txt @@ -25,9 +25,9 @@ Usage Examples Insert Multiple Documents Update a Document Update Multiple Documents - Update a Document - Update Multiple Documents - Replace a Document + Replace a Document + Delete a Documents + Delete Multiple Documents Count Documents List Distinct Field Values From e41155305b3eba67dc9f23e95531e143e43d455c Mon Sep 17 00:00:00 2001 From: Lindsey Moore Date: Wed, 13 Nov 2024 13:42:19 -0500 Subject: [PATCH 3/3] internal review changes --- source/fundamentals.txt | 2 +- source/fundamentals/crud/read-operations.txt | 6 +++--- source/index.txt | 2 +- source/quick-start.txt | 4 ++-- source/usage-examples.txt | 22 ++++++++++---------- 5 files changed, 18 insertions(+), 18 deletions(-) diff --git a/source/fundamentals.txt b/source/fundamentals.txt index 68cfeda0..95337c82 100644 --- a/source/fundamentals.txt +++ b/source/fundamentals.txt @@ -21,7 +21,7 @@ Fundamentals Transactions Time Series Collections Tracing & Logging - Run a Command + Database Commands Performance Considerations Async & Sync APIs Monitoring diff --git a/source/fundamentals/crud/read-operations.txt b/source/fundamentals/crud/read-operations.txt index a836b1be..b77f6c30 100644 --- a/source/fundamentals/crud/read-operations.txt +++ b/source/fundamentals/crud/read-operations.txt @@ -9,12 +9,12 @@ Read Operations Retrieve Data Specify a Query - Data from a Cursor + Data Cursors Open Change Streams Search Text Sort Results - Skip Returned Results - Limit Returned Results + Skip Results + Limit Results .. /fundamentals/crud/read-operations/count diff --git a/source/index.txt b/source/index.txt index fdc5c220..4d4780b6 100644 --- a/source/index.txt +++ b/source/index.txt @@ -9,7 +9,7 @@ Quick Start Quick Reference What's New - Usage Examples + CRUD Examples Fundamentals API Documentation <{+api+}/> FAQ diff --git a/source/quick-start.txt b/source/quick-start.txt index 72831697..045bfc3c 100644 --- a/source/quick-start.txt +++ b/source/quick-start.txt @@ -20,9 +20,9 @@ Rust Driver Quick Start .. toctree:: Download & Install - Create a MongDB Deployment + Create a Deployment Create a Connection String - Connect to MongoDB + Connect Next Steps Overview diff --git a/source/usage-examples.txt b/source/usage-examples.txt index 971a484f..77ad6449 100644 --- a/source/usage-examples.txt +++ b/source/usage-examples.txt @@ -19,17 +19,17 @@ Usage Examples .. toctree:: - Find a Document - Find Multiple Documents - Insert a Document - Insert Multiple Documents - Update a Document - Update Multiple Documents - Replace a Document - Delete a Documents - Delete Multiple Documents - Count Documents - List Distinct Field Values + Find One + Find Multiple + Insert One + Insert Multiple + Update One + Update Multiple + Replace One + Delete One + Delete Multiple + Count + List Distinct Values Overview --------