From ab6c9b8e91b978e6fdab5efed4c40f2eedbac260 Mon Sep 17 00:00:00 2001 From: Lindsey Moore Date: Thu, 21 Nov 2024 18:33:40 -0500 Subject: [PATCH] DOCSP-44904 Shorten TOC Labels --- source/connect.txt | 10 +++++----- source/data-formats.txt | 8 ++++---- source/get-started.txt | 10 +++++----- source/index.txt | 26 +++++++++++++------------- source/indexes.txt | 2 +- source/indexes/single-field-index.txt | 12 ++++++------ source/read.txt | 16 ++++++++-------- source/work-with-indexes.txt | 6 +++--- source/write-operations.txt | 12 ++++++------ 9 files changed, 51 insertions(+), 51 deletions(-) diff --git a/source/connect.txt b/source/connect.txt index b2f4e0e..b0659ec 100644 --- a/source/connect.txt +++ b/source/connect.txt @@ -22,11 +22,11 @@ Connect to MongoDB :titlesonly: :maxdepth: 1 - /connect/mongoclient - /connect/connection-targets - /connect/connection-options - /connect/tls - /connect/stable-api + Create a MongoClient + Choose a Connection Target + Connection Options + Enable TLS + Stable API .. /connect/network-compression .. /connect/server-selection diff --git a/source/data-formats.txt b/source/data-formats.txt index fa38cbc..1f30420 100644 --- a/source/data-formats.txt +++ b/source/data-formats.txt @@ -21,10 +21,10 @@ Specialized Data Formats :titlesonly: :maxdepth: 1 - /data-formats/serialization - /data-formats/codecs - /data-formats/bson - /data-formats/time-series + Kotlin Serialization + Codecs + BSON + Time Series .. TODO: /data-formats/data-class .. TODO: /data-formats/extended-json diff --git a/source/get-started.txt b/source/get-started.txt index ed15a44..40d4467 100644 --- a/source/get-started.txt +++ b/source/get-started.txt @@ -20,11 +20,11 @@ Get Started with the Kotlin Sync Driver .. 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 + Next Steps Overview -------- diff --git a/source/index.txt b/source/index.txt index ffdb6b9..652316c 100644 --- a/source/index.txt +++ b/source/index.txt @@ -14,19 +14,19 @@ .. toctree:: Get Started - /connect - /write-operations - /read - /indexes - /aggregation - Use Aggregation Expression Operations - /data-formats - /builders - /encrypt-fields - /compatibility - Validate Driver Artifact Signatures - /whats-new - /issues-and-help + Connect + Write Data + Read Data + Indexes + Data Aggregation + Aggregation Expression Operations + Specialized Data Formats + Builders + In-Use Encryption + Compatibility + Validate Driver Signatures + What's New + Issues & Help View the Source API Documentation <{+api+}/com.mongodb.kotlin.client/index.html> diff --git a/source/indexes.txt b/source/indexes.txt index 0924230..7a1bf0b 100644 --- a/source/indexes.txt +++ b/source/indexes.txt @@ -22,7 +22,7 @@ Optimize Queries by Using Indexes :titlesonly: :maxdepth: 1 - /work-with-indexes + Work with Indexes Overview -------- diff --git a/source/indexes/single-field-index.txt b/source/indexes/single-field-index.txt index 8eca6e8..c36e0e5 100644 --- a/source/indexes/single-field-index.txt +++ b/source/indexes/single-field-index.txt @@ -1,7 +1,7 @@ .. _kotlin-sync-single-field-index: ==================== -Single-Field Indexes +Single Field Indexes ==================== .. contents:: On this page @@ -20,19 +20,19 @@ Single-Field Indexes Overview -------- -:manual:`Single-field indexes ` are indexes with a reference to a +: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. -When creating a single-field index, you must specify the following: +When creating a single field index, you must specify the following: - The field on which to create the index - The sort order for the indexed values (ascending or descending) .. note:: - The ``_id_`` index is an example of a single-field index. This index is automatically + 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 @@ -51,7 +51,7 @@ The following {+language+} data class models the documents in this collection: :language: kotlin :copyable: -Create Single-Field Index +Create Single Field Index ------------------------- The following example creates an index in ascending order on the ``title`` field: @@ -82,7 +82,7 @@ The following is an example of a query that is covered by the index created in t Additional Information ---------------------- -To learn more about single-field indexes, see :manual:`Single Field Indexes ` +To learn more about single field indexes, see :manual:`Single Field Indexes ` in the {+mdb-server+} manual. API Documentation diff --git a/source/read.txt b/source/read.txt index ab4ecf8..9174627 100644 --- a/source/read.txt +++ b/source/read.txt @@ -22,14 +22,14 @@ Read Data from MongoDB :titlesonly: :maxdepth: 1 - /read/specify-a-query - /read/retrieve - /read/project - /read/specify-documents-to-return - /read/count - /read/distinct - /read/cursors - /read/change-streams + Specify a Query + Retrieve Data + Specify Fields to Return + Specify Documents to Return + Count Documents + Distinct Field Values + Data Cursors + Monitor Data Changes Overview -------- diff --git a/source/work-with-indexes.txt b/source/work-with-indexes.txt index 435119f..4114602 100644 --- a/source/work-with-indexes.txt +++ b/source/work-with-indexes.txt @@ -19,9 +19,9 @@ Work with Indexes .. toctree:: - /indexes/single-field-index.txt - /indexes/compound-index.txt - /indexes/atlas-search-index.txt + Single Field + Compound + Atlas & Vector Search Overview -------- diff --git a/source/write-operations.txt b/source/write-operations.txt index 19b7e69..6e2d02c 100644 --- a/source/write-operations.txt +++ b/source/write-operations.txt @@ -22,12 +22,12 @@ Write Data to MongoDB :titlesonly: :maxdepth: 1 - /write/insert - /write/update - /write/replace - /write/delete - /write/bulk-write - /write/transactions + Insert + Update + Replace + Delete + Bulk Write + Transactions .. /write/gridfs