From 33c89cc5decb6c865bb2b6bca0513c7907b80666 Mon Sep 17 00:00:00 2001 From: Lindsey Moore Date: Fri, 8 Nov 2024 22:21:48 -0500 Subject: [PATCH 1/4] DOCSP-44902 TOC Relabel --- source/fundamentals.txt | 34 ++++++++++----------- source/fundamentals/builders.txt | 12 ++++---- source/fundamentals/connection.txt | 12 ++++---- source/fundamentals/crud.txt | 8 ++--- source/fundamentals/data-formats.txt | 20 ++++++------ source/index.txt | 22 ++++++------- source/usage-examples.txt | 19 ++++++------ source/usage-examples/delete-operations.txt | 10 +++--- source/usage-examples/find-operations.txt | 10 +++--- source/usage-examples/insert-operations.txt | 10 +++--- source/usage-examples/update-operations.txt | 14 ++++----- 11 files changed, 85 insertions(+), 86 deletions(-) diff --git a/source/fundamentals.txt b/source/fundamentals.txt index a44f2708..9ea37b6c 100644 --- a/source/fundamentals.txt +++ b/source/fundamentals.txt @@ -8,23 +8,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/time-series - /fundamentals/encrypt-fields + Connection Guide + Authentication + Enterprise Authentication + Stable API + Databases & Collections + Data Formats + CRUD Operations /fundamentals/crud + Builders + Aggregation + Aggregation Expressions + Indexes + Transactions + Collations + Logging + Monitoring + Time Series Collections + In-Use Encryption .. TODO : add back in after MVP .. /fundamentals/gridfs diff --git a/source/fundamentals/builders.txt b/source/fundamentals/builders.txt index 4660b942..27722f26 100644 --- a/source/fundamentals/builders.txt +++ b/source/fundamentals/builders.txt @@ -6,12 +6,12 @@ Builders .. toctree:: - /fundamentals/builders/aggregates - /fundamentals/builders/filters - /fundamentals/builders/indexes - /fundamentals/builders/projections - /fundamentals/builders/sort - /fundamentals/builders/updates + Aggregates + Filters + Indexes + Projections + Sorts + Updates .. contents:: On this page :local: diff --git a/source/fundamentals/connection.txt b/source/fundamentals/connection.txt index 5c8de999..36866264 100644 --- a/source/fundamentals/connection.txt +++ b/source/fundamentals/connection.txt @@ -6,12 +6,12 @@ Connection Guide .. toctree:: - /fundamentals/connection/connect - /fundamentals/connection/connection-options - /fundamentals/connection/mongoclientsettings - /fundamentals/connection/network-compression - /fundamentals/connection/tls - /fundamentals/connection/socks5 + Connect to MongoDB + Connection Options + Specify MongoClient Settings + Network Compression + TLS/SSL + SOCKS5 Proxy Connection .. contents:: On this page :local: diff --git a/source/fundamentals/crud.txt b/source/fundamentals/crud.txt index 80eb72ab..ae279cd7 100644 --- a/source/fundamentals/crud.txt +++ b/source/fundamentals/crud.txt @@ -7,10 +7,10 @@ CRUD Operations .. toctree:: :caption: CRUD Operations - /fundamentals/crud/read-operations - /fundamentals/crud/write-operations - /fundamentals/crud/query-document - /fundamentals/crud/compound-operations + Read Operations + Write Operations + Query + Compound Operations CRUD (Create, Read, Update, Delete) operations enable you to work with data stored in MongoDB. diff --git a/source/fundamentals/data-formats.txt b/source/fundamentals/data-formats.txt index 03036c47..5737e098 100644 --- a/source/fundamentals/data-formats.txt +++ b/source/fundamentals/data-formats.txt @@ -2,19 +2,19 @@ Data Formats ============ +.. toctree:: + :caption: Data Formats + + Data Classes + BSON + Extended JSON + Documents + Kotlin Serialization + Codecs + - :doc:`/fundamentals/data-formats/document-data-format-data-class` - :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/serialization` - :doc:`/fundamentals/data-formats/codecs` - -.. toctree:: - :caption: Data Formats - - /fundamentals/data-formats/document-data-format-data-class - /fundamentals/data-formats/document-data-format-bson - /fundamentals/data-formats/document-data-format-extended-json - /fundamentals/data-formats/documents - /fundamentals/data-formats/serialization - /fundamentals/data-formats/codecs diff --git a/source/index.txt b/source/index.txt index 81f86e41..84084892 100644 --- a/source/index.txt +++ b/source/index.txt @@ -7,17 +7,17 @@ MongoDB Kotlin Driver :maxdepth: 1 Quick Start - /quick-reference - /whats-new - /usage-examples - /fundamentals - /api-documentation - /faq - /connection-troubleshooting - /issues-and-help - /compatibility - /migrate-kmongo - /validate-signatures + Quick Reference + What's New + Usage Examples + Fundamentals + API Documentation + FAQ + Connection Troubleshooting + Issues & Help + Compatibility + Migrate from KMongo + Validate Driver Signatures View the Source Introduction diff --git a/source/usage-examples.txt b/source/usage-examples.txt index 1e3844c2..32b41552 100644 --- a/source/usage-examples.txt +++ b/source/usage-examples.txt @@ -10,16 +10,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 Operations + Insert Operations + Update & Replaces Operations + Delete Operations + Bulk Operations + watch for Changes + Count Documents + Distinct Field Values + Run a Command Overview -------- diff --git a/source/usage-examples/delete-operations.txt b/source/usage-examples/delete-operations.txt index dc6f748e..e98fb860 100644 --- a/source/usage-examples/delete-operations.txt +++ b/source/usage-examples/delete-operations.txt @@ -2,12 +2,12 @@ Delete Operations ================= -- :doc:`Delete a Document ` -- :doc:`Delete Multiple Documents ` - .. toctree:: :caption: Examples - /usage-examples/deleteOne - /usage-examples/deleteMany + Delete a Document + Delete Multiple Documents + +- :doc:`Delete a Document ` +- :doc:`Delete Multiple Documents ` \ No newline at end of file diff --git a/source/usage-examples/find-operations.txt b/source/usage-examples/find-operations.txt index faa91153..379fdf6f 100644 --- a/source/usage-examples/find-operations.txt +++ b/source/usage-examples/find-operations.txt @@ -2,11 +2,11 @@ Find Operations =============== -- :doc:`Find a Document ` -- :doc:`Find Multiple Documents ` - .. toctree:: :caption: Examples - /usage-examples/findOne - /usage-examples/find + Find a Document + Find Multiple Documents + +- :doc:`Find a Document ` +- :doc:`Find Multiple Documents ` diff --git a/source/usage-examples/insert-operations.txt b/source/usage-examples/insert-operations.txt index 05005b02..1310dad2 100644 --- a/source/usage-examples/insert-operations.txt +++ b/source/usage-examples/insert-operations.txt @@ -2,11 +2,11 @@ Insert Operations ================= -- :doc:`Insert a Document ` -- :doc:`Insert Multiple Documents ` - .. toctree:: :caption: Examples - /usage-examples/insertOne - /usage-examples/insertMany + Insert a Document + Insert Multiple Documents + +- :doc:`Insert a Document ` +- :doc:`Insert Multiple Documents ` diff --git a/source/usage-examples/update-operations.txt b/source/usage-examples/update-operations.txt index 802aefff..d8081547 100644 --- a/source/usage-examples/update-operations.txt +++ b/source/usage-examples/update-operations.txt @@ -2,13 +2,13 @@ Update & Replace Operations =========================== -- :doc:`Update a Document ` -- :doc:`Update Multiple Documents ` -- :doc:`Replace a Document ` - .. toctree:: :caption: Examples - /usage-examples/updateOne - /usage-examples/updateMany - /usage-examples/replaceOne + Update a Document + Update Multiple Documents + Replace a Document + +- :doc:`Update a Document ` +- :doc:`Update Multiple Documents ` +- :doc:`Replace a Document ` From d3aa18ae38eeffac481a9824073cb6580aae7e2c Mon Sep 17 00:00:00 2001 From: Lindsey Moore Date: Fri, 8 Nov 2024 22:35:20 -0500 Subject: [PATCH 2/4] DOCSP-44902 TOC Relabel --- source/fundamentals/connection.txt | 2 +- source/usage-examples.txt | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/source/fundamentals/connection.txt b/source/fundamentals/connection.txt index 36866264..8aed7e10 100644 --- a/source/fundamentals/connection.txt +++ b/source/fundamentals/connection.txt @@ -8,7 +8,7 @@ Connection Guide Connect to MongoDB Connection Options - Specify MongoClient Settings + MongoClient Settings Network Compression TLS/SSL SOCKS5 Proxy Connection diff --git a/source/usage-examples.txt b/source/usage-examples.txt index 32b41552..6edb19d3 100644 --- a/source/usage-examples.txt +++ b/source/usage-examples.txt @@ -15,7 +15,7 @@ Usage Examples Update & Replaces Operations Delete Operations Bulk Operations - watch for Changes + Watch for Changes Count Documents Distinct Field Values Run a Command From ac273b1185ff2f9654192405a29df0646c77c6dc Mon Sep 17 00:00:00 2001 From: Lindsey Moore Date: Wed, 20 Nov 2024 17:26:48 -0500 Subject: [PATCH 3/4] Mike's suggestions --- source/fundamentals/builders.txt | 8 ++++---- source/fundamentals/crud.txt | 4 ++-- source/usage-examples.txt | 8 ++++---- 3 files changed, 10 insertions(+), 10 deletions(-) diff --git a/source/fundamentals/builders.txt b/source/fundamentals/builders.txt index 27722f26..7bd54273 100644 --- a/source/fundamentals/builders.txt +++ b/source/fundamentals/builders.txt @@ -6,12 +6,12 @@ Builders .. toctree:: - Aggregates + Aggregation Filters Indexes - Projections - Sorts - Updates + Projection + Sort + Update .. contents:: On this page :local: diff --git a/source/fundamentals/crud.txt b/source/fundamentals/crud.txt index ae279cd7..ea152d08 100644 --- a/source/fundamentals/crud.txt +++ b/source/fundamentals/crud.txt @@ -7,8 +7,8 @@ CRUD Operations .. toctree:: :caption: CRUD Operations - Read Operations - Write Operations + Read + Write Query Compound Operations diff --git a/source/usage-examples.txt b/source/usage-examples.txt index 6edb19d3..56cb08d2 100644 --- a/source/usage-examples.txt +++ b/source/usage-examples.txt @@ -10,10 +10,10 @@ Usage Examples .. toctree:: - Find Operations - Insert Operations - Update & Replaces Operations - Delete Operations + Find + Insert + Update & Replaces + Delete Bulk Operations Watch for Changes Count Documents From 60bff2346cd2dcc0cf58415f60bf9367caba5754 Mon Sep 17 00:00:00 2001 From: Lindsey Moore Date: Thu, 21 Nov 2024 14:42:03 -0500 Subject: [PATCH 4/4] 'one/many' operation changes --- source/usage-examples/delete-operations.txt | 4 ++-- source/usage-examples/find-operations.txt | 4 ++-- source/usage-examples/insert-operations.txt | 4 ++-- source/usage-examples/update-operations.txt | 6 +++--- 4 files changed, 9 insertions(+), 9 deletions(-) diff --git a/source/usage-examples/delete-operations.txt b/source/usage-examples/delete-operations.txt index e98fb860..f1574e01 100644 --- a/source/usage-examples/delete-operations.txt +++ b/source/usage-examples/delete-operations.txt @@ -5,8 +5,8 @@ Delete Operations .. toctree:: :caption: Examples - Delete a Document - Delete Multiple Documents + Delete One + Delete Many - :doc:`Delete a Document ` - :doc:`Delete Multiple Documents ` diff --git a/source/usage-examples/find-operations.txt b/source/usage-examples/find-operations.txt index 379fdf6f..17d2f6d8 100644 --- a/source/usage-examples/find-operations.txt +++ b/source/usage-examples/find-operations.txt @@ -5,8 +5,8 @@ Find Operations .. toctree:: :caption: Examples - Find a Document - Find Multiple Documents + Find One + Find Many - :doc:`Find a Document ` - :doc:`Find Multiple Documents ` diff --git a/source/usage-examples/insert-operations.txt b/source/usage-examples/insert-operations.txt index 1310dad2..74fe1d7a 100644 --- a/source/usage-examples/insert-operations.txt +++ b/source/usage-examples/insert-operations.txt @@ -5,8 +5,8 @@ Insert Operations .. toctree:: :caption: Examples - Insert a Document - Insert Multiple Documents + Insert One + Insert Many - :doc:`Insert a Document ` - :doc:`Insert Multiple Documents ` diff --git a/source/usage-examples/update-operations.txt b/source/usage-examples/update-operations.txt index d8081547..0513e947 100644 --- a/source/usage-examples/update-operations.txt +++ b/source/usage-examples/update-operations.txt @@ -5,9 +5,9 @@ Update & Replace Operations .. toctree:: :caption: Examples - Update a Document - Update Multiple Documents - Replace a Document + Update One + Update Many + Replace One - :doc:`Update a Document ` - :doc:`Update Multiple Documents `