From ea89e8b28d06f6920c1a88339e135554323faf0b Mon Sep 17 00:00:00 2001 From: Lindsey Moore Date: Mon, 11 Nov 2024 11:43:48 -0500 Subject: [PATCH 1/6] DOCSP-44948 TOC Relabel --- source/index.txt | 32 ++++++++++++++++---------------- 1 file changed, 16 insertions(+), 16 deletions(-) diff --git a/source/index.txt b/source/index.txt index 8b142745..6b5ec115 100644 --- a/source/index.txt +++ b/source/index.txt @@ -13,22 +13,22 @@ MongoDB {+driver-short+} Documentation .. toctree:: Get Started - /connect - /databases-collections - /write-operations - /read - /run-command - /indexes - /aggregation - /security - /data-formats - /tools - /faq - /troubleshooting - /whats-new - /upgrade - /motor-async-migration - /pymongo-to-async-guide + Connect to MongoDB + Databases & Collections + Write Data + read Data + Run a Database Command + Indexes + Aggregation + Security + Data Formats + Third-Party Tools + FAQ + Troubleshooting + What's New + Upgrade + Migrate Motor to PyMongo Async + Switch PyMongo to PyMongo Async/pymongo-to-async-guide /previous-versions /issues-and-help /compatibility From 712b553c1ec623347d20cd46749fa5092f8641ca Mon Sep 17 00:00:00 2001 From: Lindsey Moore Date: Mon, 11 Nov 2024 12:30:28 -0500 Subject: [PATCH 2/6] final changes --- source/aggregation.txt | 2 +- source/aggregation/aggregation-tutorials.txt | 10 +++++----- source/connect.txt | 16 ++++++++-------- source/data-formats.txt | 8 ++++---- source/get-started.txt | 10 +++++----- source/index.txt | 10 +++++----- source/indexes.txt | 2 +- source/read.txt | 16 ++++++++-------- source/security.txt | 6 +++--- source/work-with-indexes.txt | 18 +++++++++--------- source/write-operations.txt | 14 +++++++------- 11 files changed, 56 insertions(+), 56 deletions(-) diff --git a/source/aggregation.txt b/source/aggregation.txt index b0903ea1..82d4160f 100644 --- a/source/aggregation.txt +++ b/source/aggregation.txt @@ -22,7 +22,7 @@ Transform Your Data with Aggregation :titlesonly: :maxdepth: 1 - /aggregation/aggregation-tutorials + Tutorials Overview -------- diff --git a/source/aggregation/aggregation-tutorials.txt b/source/aggregation/aggregation-tutorials.txt index 6f58782e..7be3e3d8 100644 --- a/source/aggregation/aggregation-tutorials.txt +++ b/source/aggregation/aggregation-tutorials.txt @@ -19,11 +19,11 @@ Aggregation Tutorials .. toctree:: - /aggregation/aggregation-tutorials/filtered-subset/ - /aggregation/aggregation-tutorials/group-total/ - /aggregation/aggregation-tutorials/unpack-arrays/ - /aggregation/aggregation-tutorials/one-to-one-join/ - /aggregation/aggregation-tutorials/multi-field-join/ + Filtered Subset + Group & Total + Unpack Arrays & Group + One-to-One Join + Multi-Field Join Overview -------- diff --git a/source/connect.txt b/source/connect.txt index dc6c2609..6c983b01 100644 --- a/source/connect.txt +++ b/source/connect.txt @@ -22,14 +22,14 @@ Connect to MongoDB :titlesonly: :maxdepth: 1 - /connect/mongoclient - /connect/connection-targets - /connect/connection-options - /connect/tls - /connect/network-compression - /connect/server-selection - /connect/stable-api - /connect/csot + Create a MongoClient + Choose a Connection Target + Specify Connection Options + Configure TLS + Compress Network Traffic + Customize Server Selection + Stable API + Limit Server Execution Time Overview -------- diff --git a/source/data-formats.txt b/source/data-formats.txt index ce4ca5d4..5c518383 100644 --- a/source/data-formats.txt +++ b/source/data-formats.txt @@ -21,10 +21,10 @@ Specialized Data Formats :titlesonly: :maxdepth: 1 - /data-formats/custom-types - /data-formats/dates-and-times - /data-formats/uuid - /data-formats/time-series + Custom Types + Dates & Times + UUIDs + Time Series Data Overview -------- diff --git a/source/get-started.txt b/source/get-started.txt index 8aa88a9e..04f5b3b6 100644 --- a/source/get-started.txt +++ b/source/get-started.txt @@ -20,11 +20,11 @@ Get Started with {+driver-short+} .. toctree:: - /get-started/download-and-install/ - /get-started/create-a-deployment/ - /get-started/create-a-connection-string/ - /get-started/connect-to-mongodb/ - /get-started/next-steps/ + Download & Install + Create a Deployment + Create a Connection String + Connect to MongoDB + Next Steps Overview -------- diff --git a/source/index.txt b/source/index.txt index 6b5ec115..09093043 100644 --- a/source/index.txt +++ b/source/index.txt @@ -16,7 +16,7 @@ MongoDB {+driver-short+} Documentation Connect to MongoDB Databases & Collections Write Data - read Data + Read Data Run a Database Command Indexes Aggregation @@ -28,10 +28,10 @@ MongoDB {+driver-short+} Documentation What's New Upgrade Migrate Motor to PyMongo Async - Switch PyMongo to PyMongo Async/pymongo-to-async-guide - /previous-versions - /issues-and-help - /compatibility + Switch PyMongo to PyMongo Async + Previous Versions + Issues & Help + Compatibility API Documentation <{+api-root+}> Overview diff --git a/source/indexes.txt b/source/indexes.txt index 0e19c51d..0580f4e5 100644 --- a/source/indexes.txt +++ b/source/indexes.txt @@ -22,7 +22,7 @@ Optimize Queries with Indexes :titlesonly: :maxdepth: 1 - /work-with-indexes + Work with Indexes + Retrieve Data + Specify Fields to Return + Specify Documents to Return + Count Documents + Distinct Field Values + Access Data from a Cursor + Monitor Data Changes Overview -------- diff --git a/source/security.txt b/source/security.txt index b4509001..80748fcd 100644 --- a/source/security.txt +++ b/source/security.txt @@ -22,9 +22,9 @@ Secure Your Data :titlesonly: :maxdepth: 1 - /security/authentication - /security/enterprise-authentication - /security/in-use-encryption + Authentication + Enterprise Authentication + In-Use Encryption Overview -------- diff --git a/source/work-with-indexes.txt b/source/work-with-indexes.txt index 75ab81e1..897b34ae 100644 --- a/source/work-with-indexes.txt +++ b/source/work-with-indexes.txt @@ -19,15 +19,15 @@ Work with Indexes .. toctree:: - /indexes/single-field-index.txt - /indexes/compound-index.txt - /indexes/multikey-index.txt - /indexes/atlas-search-index.txt - /indexes/text-index.txt - /indexes/geospatial-index.txt - /indexes/unique-index.txt - /indexes/wildcard-index.txt - /indexes/clustered-index.txt + Single-Field Indexes + Compound Indexes + Multikey Indexes + Atlas Search Indexes /indexes/atlas-search-index.txt + Text Indexes + Geospatial Indexes + Unique Indexes + Wildcard Indexes + Clustered Indexes Overview -------- diff --git a/source/write-operations.txt b/source/write-operations.txt index 7ce72cb6..ba791941 100644 --- a/source/write-operations.txt +++ b/source/write-operations.txt @@ -22,13 +22,13 @@ Write Data to MongoDB :titlesonly: :maxdepth: 1 - /write/insert - /write/update - /write/replace - /write/delete - /write/bulk-write - /write/gridfs - /write/transactions + Insert + Update + Replace + Delete + Bulk Write Operations + Store Large Files + Transactions Overview -------- From e0ff39778f5de8e68709ae80dbf43c59b8d86147 Mon Sep 17 00:00:00 2001 From: Lindsey Moore Date: Mon, 11 Nov 2024 12:58:12 -0500 Subject: [PATCH 3/6] 2 line edit :( --- source/index.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/index.txt b/source/index.txt index 09093043..595690c2 100644 --- a/source/index.txt +++ b/source/index.txt @@ -28,7 +28,7 @@ MongoDB {+driver-short+} Documentation What's New Upgrade Migrate Motor to PyMongo Async - Switch PyMongo to PyMongo Async + Switch to PyMongo Async Previous Versions Issues & Help Compatibility From c6e2d42c933a6ed50d83f19b3ffa10a711028229 Mon Sep 17 00:00:00 2001 From: Lindsey Moore Date: Wed, 20 Nov 2024 19:06:55 -0500 Subject: [PATCH 4/6] suggestions --- source/get-started.txt | 2 +- source/index.txt | 4 ++-- source/indexes.txt | 2 +- source/indexes/single-field-index.txt | 8 ++++---- source/work-with-indexes.txt | 18 +++++++++--------- 5 files changed, 17 insertions(+), 17 deletions(-) diff --git a/source/get-started.txt b/source/get-started.txt index 04f5b3b6..7229eb3f 100644 --- a/source/get-started.txt +++ b/source/get-started.txt @@ -23,7 +23,7 @@ Get Started with {+driver-short+} Download & Install Create a Deployment Create a Connection String - Connect to MongoDB + Connect Next Steps Overview diff --git a/source/index.txt b/source/index.txt index 595690c2..8ca66669 100644 --- a/source/index.txt +++ b/source/index.txt @@ -13,7 +13,7 @@ MongoDB {+driver-short+} Documentation .. toctree:: Get Started - Connect to MongoDB + Connect Databases & Collections Write Data Read Data @@ -27,7 +27,7 @@ MongoDB {+driver-short+} Documentation Troubleshooting What's New Upgrade - Migrate Motor to PyMongo Async + Migrate from Motor Switch to PyMongo Async Previous Versions Issues & Help diff --git a/source/indexes.txt b/source/indexes.txt index 0580f4e5..f57f4d27 100644 --- a/source/indexes.txt +++ b/source/indexes.txt @@ -22,7 +22,7 @@ Optimize Queries with Indexes :titlesonly: :maxdepth: 1 - Work with Indexes Overview -------- diff --git a/source/indexes/single-field-index.txt b/source/indexes/single-field-index.txt index acce22e5..163d32be 100644 --- a/source/indexes/single-field-index.txt +++ b/source/indexes/single-field-index.txt @@ -1,7 +1,7 @@ .. _pymongo-single-field-index: ==================== -Single-Field Indexes +Single Field Indexes ==================== .. contents:: On this page @@ -20,13 +20,13 @@ Single-Field Indexes Overview -------- -:manual:`Single-field indexes ` are indexes with a reference to a single field within a collection's +:manual:`Single field indexes ` are indexes with a reference to a single field within a collection's documents. They improve single field query and sort performance, and support :manual:`TTL Indexes ` that automatically remove documents from a collection after a certain amount of time or at a specific clock time. .. note:: - The ``_id_`` index is an example of a single-field index. This index is automatically created on the ``_id`` field + The ``_id_`` index is an example of a single field index. This index is automatically created on the ``_id`` field when a new collection is created. Sample Data @@ -37,7 +37,7 @@ from the :atlas:`Atlas sample datasets `. To learn how to create a free MongoDB Atlas cluster and load the sample datasets, see the :ref:``. -Create Single-Field Index +Create Single Field Index ------------------------- The following example creates an index in ascending order on the ``title`` field: diff --git a/source/work-with-indexes.txt b/source/work-with-indexes.txt index 897b34ae..cc89a23a 100644 --- a/source/work-with-indexes.txt +++ b/source/work-with-indexes.txt @@ -19,15 +19,15 @@ Work with Indexes .. toctree:: - Single-Field Indexes - Compound Indexes - Multikey Indexes - Atlas Search Indexes /indexes/atlas-search-index.txt - Text Indexes - Geospatial Indexes - Unique Indexes - Wildcard Indexes - Clustered Indexes + Single Field + Compound + Multikey + Atlas Search /indexes/atlas-search-index.txt + Text + Geospatial + Unique + Wildcard + Clustered Overview -------- From 8ac77f96b7e90b096e815242604e463e3b4b3291 Mon Sep 17 00:00:00 2001 From: Lindsey Moore Date: Wed, 20 Nov 2024 19:17:50 -0500 Subject: [PATCH 5/6] linking format --- source/work-with-indexes.txt | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/source/work-with-indexes.txt b/source/work-with-indexes.txt index cc89a23a..adeefdf7 100644 --- a/source/work-with-indexes.txt +++ b/source/work-with-indexes.txt @@ -19,15 +19,15 @@ Work with Indexes .. toctree:: - Single Field - Compound - Multikey - Atlas Search /indexes/atlas-search-index.txt - Text - Geospatial - Unique - Wildcard - Clustered + Single Field + Compound + Multikey + Atlas Search + Text + Geospatial + Unique + Wildcard + Clustered Overview -------- From 364e608ac4d35e324e1ec8364615d31826e5f9d9 Mon Sep 17 00:00:00 2001 From: Lindsey Moore Date: Wed, 20 Nov 2024 19:29:10 -0500 Subject: [PATCH 6/6] edit vector search --- source/work-with-indexes.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/work-with-indexes.txt b/source/work-with-indexes.txt index adeefdf7..5c8c5cf1 100644 --- a/source/work-with-indexes.txt +++ b/source/work-with-indexes.txt @@ -22,7 +22,7 @@ Work with Indexes Single Field Compound Multikey - Atlas Search + Atlas & Vector Search Text Geospatial Unique