Skip to content

Commit

Permalink
DOCSP-44904 Shorten TOC Labels (#55) (#57)
Browse files Browse the repository at this point in the history
* DOCSP-44904 Shorten TOC Labels

* Lauren suggestion

(cherry picked from commit fe5d9f8)
  • Loading branch information
lindseymoore authored Nov 22, 2024
1 parent c75a8a6 commit ad11442
Show file tree
Hide file tree
Showing 9 changed files with 50 additions and 50 deletions.
10 changes: 5 additions & 5 deletions source/connect.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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 </connect/mongoclient>
Choose a Connection Target </connect/connection-targets>
Connection Options </connect/connection-options>
Enable TLS </connect/tls>
Stable API </connect/stable-api>

.. /connect/network-compression
.. /connect/server-selection
Expand Down
8 changes: 4 additions & 4 deletions source/data-formats.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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 </data-formats/serialization>
Codecs </data-formats/codecs>
BSON </data-formats/bson>
Time Series </data-formats/time-series>

.. TODO: /data-formats/data-class
.. TODO: /data-formats/extended-json
Expand Down
10 changes: 5 additions & 5 deletions source/get-started.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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 </get-started/download-and-install/>
Create a Deployment </get-started/create-a-deployment/>
Create a Connection String </get-started/create-a-connection-string/>
Connect </get-started/connect-to-mongodb/>
Next Steps </get-started/next-steps/>

Overview
--------
Expand Down
24 changes: 12 additions & 12 deletions source/index.txt
Original file line number Diff line number Diff line change
Expand Up @@ -14,18 +14,18 @@
.. toctree::

Get Started </get-started>
/connect
/write-operations
/read
/indexes
/aggregation
Use Aggregation Expression Operations </agg-exp-ops>
/data-formats
/builders
/encrypt-fields
/compatibility
Validate Driver Artifact Signatures </validate-signatures>
/whats-new
Connect </connect>
Write Data </write-operations>
Read Data </read>
Indexes </indexes>
Data Aggregation </aggregation>
Aggregation Operations </agg-exp-ops>
Specialized Data Formats </data-formats>
Builders </builders>
In-Use Encryption </encrypt-fields>
Compatibility </compatibility>
Validate Driver Signatures </validate-signatures>
What's New </whats-new>
View the Source <https://github.com/mongodb/mongo-java-driver/tree/master/driver-kotlin-sync>
API Documentation <{+api+}/com.mongodb.kotlin.client/index.html>

Expand Down
2 changes: 1 addition & 1 deletion source/indexes.txt
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ Optimize Queries by Using Indexes
:titlesonly:
:maxdepth: 1

/work-with-indexes
Work with Indexes </work-with-indexes>

Overview
--------
Expand Down
12 changes: 6 additions & 6 deletions source/indexes/single-field-index.txt
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
.. _kotlin-sync-single-field-index:

====================
Single-Field Indexes
Single Field Indexes
====================

.. contents:: On this page
Expand All @@ -20,19 +20,19 @@ Single-Field Indexes
Overview
--------

:manual:`Single-field indexes </core/index-single/>` are indexes with a reference to a
:manual:`Single field indexes </core/index-single/>` 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 </core/index-ttl>` 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
Expand All @@ -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:
Expand Down Expand Up @@ -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 </core/index-single>`
To learn more about single field indexes, see :manual:`Single Field Indexes </core/index-single>`
in the {+mdb-server+} manual.

API Documentation
Expand Down
16 changes: 8 additions & 8 deletions source/read.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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 </read/specify-a-query>
Retrieve Data </read/retrieve>
Specify Fields to Return </read/project>
Specify Documents to Return </read/specify-documents-to-return>
Count Documents </read/count>
Distinct Field Values </read/distinct>
Data Cursors </read/cursors>
Monitor Data Changes </read/change-streams>

Overview
--------
Expand Down
6 changes: 3 additions & 3 deletions source/work-with-indexes.txt
Original file line number Diff line number Diff line change
Expand Up @@ -19,9 +19,9 @@ Work with Indexes

.. toctree::

/indexes/single-field-index.txt
/indexes/compound-index.txt
/indexes/atlas-search-index.txt
Single Field </indexes/single-field-index>
Compound </indexes/compound-index>
Atlas & Vector Search </indexes/atlas-search-index>

Overview
--------
Expand Down
12 changes: 6 additions & 6 deletions source/write-operations.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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 </write/insert>
Update </write/update>
Replace </write/replace>
Delete </write/delete>
Bulk Write </write/bulk-write>
Transactions </write/transactions>

..
/write/gridfs
Expand Down

0 comments on commit ad11442

Please sign in to comment.