From cd60fe13048b922e98d87811dd4afae69e3a97f7 Mon Sep 17 00:00:00 2001 From: Lindsey Moore Date: Mon, 11 Nov 2024 13:23:48 -0500 Subject: [PATCH 1/2] DOCSP-44950 TOC Relabel --- source/getting-started.txt | 12 +++---- source/index.txt | 32 +++++++++---------- .../connection-and-configuration.txt | 14 ++++---- source/reference/in-use-encryption.txt | 10 +++--- source/reference/schema-operations.txt | 10 +++--- source/reference/working-with-data.txt | 26 +++++++-------- source/tutorials.txt | 11 +++---- 7 files changed, 57 insertions(+), 58 deletions(-) diff --git a/source/getting-started.txt b/source/getting-started.txt index b92298a54..cce9ef66e 100644 --- a/source/getting-started.txt +++ b/source/getting-started.txt @@ -6,12 +6,12 @@ Getting Started .. default-domain:: mongodb -This section describes how to install the driver, installation prerequisites -and compatibility considerations. - .. toctree:: :titlesonly: - installation - reference/driver-compatibility - support + Installation + Driver Compatibility + Support + +This section describes how to install the driver, installation prerequisites +and compatibility considerations. diff --git a/source/index.txt b/source/index.txt index d8ab98a35..9a11a3586 100644 --- a/source/index.txt +++ b/source/index.txt @@ -8,6 +8,21 @@ Ruby MongoDB Driver .. default-domain:: mongodb +.. class:: hidden + + .. toctree:: + :titlesonly: + + Get Started + Tutorials + Connection & Configuration + Working with Data + Schema Operations + API + Release Notes + Additional Resources + Contribute to the Driver + Welcome to the documentation site for the official MongoDB Ruby driver. You can add the driver to your application to work with MongoDB in Ruby. @@ -49,19 +64,4 @@ For tutorials on Mongoid, see the `Mongoid Manual + Authentication + Monitoring + User Management + +This section describes how to create the client objects and what configuration +options the driver provides, including authentication. diff --git a/source/reference/in-use-encryption.txt b/source/reference/in-use-encryption.txt index 165f399b8..82406b867 100644 --- a/source/reference/in-use-encryption.txt +++ b/source/reference/in-use-encryption.txt @@ -6,12 +6,12 @@ In-Use Encryption .. default-domain:: mongodb -This section describes the different encryption methods in use by the Ruby -driver for MongoDB. - .. toctree:: :titlesonly: - /reference/in-use-encryption/queryable-encryption - /reference/in-use-encryption/client-side-encryption + Queryable Encryption + Client-Side Encryption + +This section describes the different encryption methods in use by the Ruby +driver for MongoDB. \ No newline at end of file diff --git a/source/reference/schema-operations.txt b/source/reference/schema-operations.txt index 8d67d569f..6acbf66b3 100644 --- a/source/reference/schema-operations.txt +++ b/source/reference/schema-operations.txt @@ -12,8 +12,8 @@ including managing databases, collections, indexes and users. .. toctree:: :titlesonly: - /reference/database-tasks - /reference/collection-tasks - /reference/indexing - /reference/search-indexes - /reference/collations + Databases + Collections + Indexes + Atlas Search Indexes + Collations diff --git a/source/reference/working-with-data.txt b/source/reference/working-with-data.txt index 0f36c6be4..e39adec49 100644 --- a/source/reference/working-with-data.txt +++ b/source/reference/working-with-data.txt @@ -12,16 +12,16 @@ implements for inserting, updating and retrieving data from MongoDB. .. toctree:: :titlesonly: - /reference/crud-operations - /reference/bulk-operations - /reference/projection - /reference/aggregation - /reference/map-reduce - /reference/text-search - /reference/geospatial-search - /reference/query-cache - /reference/gridfs - /reference/change-streams - /reference/sessions - /reference/transactions - /reference/in-use-encryption + CRUD + Bulk Writes + Projection + Aggregation + Map-Reduce + Text Search + Geospatial Search + Query Cache + GridFS + Change Streams + Sessions + Transactions + In-Use Encryption diff --git a/source/tutorials.txt b/source/tutorials.txt index 143f8edbd..bef34aeb1 100644 --- a/source/tutorials.txt +++ b/source/tutorials.txt @@ -6,14 +6,13 @@ Tutorials .. default-domain:: mongodb -The tutorials in this section provide examples of some frequently used -operations. This section is not meant to be an exhaustive list of all -operations available in the Ruby driver. - .. toctree:: :titlesonly: Quick Start - tutorials/common-errors - tutorials/bson + Common Errors + BSON Tutorial +The tutorials in this section provide examples of some frequently used +operations. This section is not meant to be an exhaustive list of all +operations available in the Ruby driver. From 12baa1b080beb8d31df5f5eb512ac136fb79e573 Mon Sep 17 00:00:00 2001 From: Lindsey Moore Date: Wed, 20 Nov 2024 18:16:00 -0500 Subject: [PATCH 2/2] Mike's suggestions --- source/getting-started.txt | 2 +- source/index.txt | 2 +- source/reference/working-with-data.txt | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/source/getting-started.txt b/source/getting-started.txt index cce9ef66e..0422bc78e 100644 --- a/source/getting-started.txt +++ b/source/getting-started.txt @@ -13,5 +13,5 @@ Getting Started Driver Compatibility Support -This section describes how to install the driver, installation prerequisites +This section describes how to install the driver, installation prerequisites, and compatibility considerations. diff --git a/source/index.txt b/source/index.txt index 9a11a3586..7343cf07f 100644 --- a/source/index.txt +++ b/source/index.txt @@ -21,7 +21,7 @@ Ruby MongoDB Driver API Release Notes Additional Resources - Contribute to the Driver + Contribute Welcome to the documentation site for the official MongoDB Ruby driver. You can add the driver to your application to work with MongoDB in diff --git a/source/reference/working-with-data.txt b/source/reference/working-with-data.txt index e39adec49..e6a5469b5 100644 --- a/source/reference/working-with-data.txt +++ b/source/reference/working-with-data.txt @@ -16,7 +16,7 @@ implements for inserting, updating and retrieving data from MongoDB. Bulk Writes Projection Aggregation - Map-Reduce + MapReduce Text Search Geospatial Search Query Cache