From 853b542e0cd0eb1974d4934fa1929c636920fa42 Mon Sep 17 00:00:00 2001 From: Lindsey Moore Date: Thu, 31 Oct 2024 16:54:15 -0400 Subject: [PATCH 1/7] DOCSP-44903 Shorten TOC Labels --- source/connect.txt | 10 +++++----- source/get-started.txt | 10 +++++----- source/index.txt | 16 ++++++++-------- 3 files changed, 18 insertions(+), 18 deletions(-) diff --git a/source/connect.txt b/source/connect.txt index 7bbdce1e..8d0b0018 100644 --- a/source/connect.txt +++ b/source/connect.txt @@ -22,11 +22,11 @@ Connect to MongoDB :titlesonly: :maxdepth: 1 - /connect/client - /connect/connection-options - /connect/connection-targets - /connect/tls - /connect/stable-api + Create a Client /connect/client + Specify Connection Options /connect/connection-options + Choose a Connection Target /connect/connection-targets + Configure TLS /connect/tls + Stable API /connect/stable-api Overview -------- diff --git a/source/get-started.txt b/source/get-started.txt index d9a61995..1c914499 100644 --- a/source/get-started.txt +++ b/source/get-started.txt @@ -20,11 +20,11 @@ Get Started with the PHP Library .. 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 and 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 to MongoDB /get-started/connect-to-mongodb/ + Next Steps /get-started/next-steps/ Overview -------- diff --git a/source/index.txt b/source/index.txt index 5627d911..eb06b9cd 100644 --- a/source/index.txt +++ b/source/index.txt @@ -11,14 +11,14 @@ MongoDB PHP Library :titlesonly: Get Started - /connect - /databases-collections - /read - /write - /read-write-pref - /run-command - /aggregation - /indexes + Connect to MongoDB /connect + Databases and Collections /databases-collections + Read Data /read + Write Data /write + Specify CRUD OPerations on Replica Sets /read-write-pref + Run a Database Command /run-command + Transform Your Data with Aggregation /aggregation + Optimize Queries /indexes /monitoring /security /data-formats From 39adc154afbe166da3ab2f51562ae44b4d656bc5 Mon Sep 17 00:00:00 2001 From: Lindsey Moore Date: Thu, 31 Oct 2024 17:38:03 -0400 Subject: [PATCH 2/7] rest of pages --- source/data-formats.txt | 9 ++++----- source/databases-collections.txt | 2 +- source/index.txt | 20 ++++++++++---------- source/indexes.txt | 10 +++++----- source/monitoring.txt | 2 +- source/read.txt | 16 ++++++++-------- source/reference.txt | 16 ++++++++-------- source/reference/result-classes.txt | 18 +++++++++--------- source/security.txt | 4 ++-- source/write.txt | 14 +++++++------- 10 files changed, 55 insertions(+), 56 deletions(-) diff --git a/source/data-formats.txt b/source/data-formats.txt index ca4e482a..449ca6f1 100644 --- a/source/data-formats.txt +++ b/source/data-formats.txt @@ -21,11 +21,10 @@ Specialized Data Formats :titlesonly: :maxdepth: 1 - /data-formats/custom-types - /data-formats/codecs - /data-formats/decimal128 - /data-formats/modeling-bson-data - + Custom Data Types /data-formats/custom-types + Codecs /data-formats/codecs + Decimal128 /data-formats/decimal128 + BSON Data /data-formats/modeling-bson-data Overview -------- diff --git a/source/databases-collections.txt b/source/databases-collections.txt index 43e2786f..48013271 100644 --- a/source/databases-collections.txt +++ b/source/databases-collections.txt @@ -21,7 +21,7 @@ Databases and Collections :titlesonly: :maxdepth: 1 - /databases-collections/time-series + Time Series /databases-collections/time-series Overview -------- diff --git a/source/index.txt b/source/index.txt index eb06b9cd..def8c5f1 100644 --- a/source/index.txt +++ b/source/index.txt @@ -15,18 +15,18 @@ MongoDB PHP Library Databases and Collections /databases-collections Read Data /read Write Data /write - Specify CRUD OPerations on Replica Sets /read-write-pref + CRUD Operations & Replica Sets /read-write-pref Run a Database Command /run-command - Transform Your Data with Aggregation /aggregation - Optimize Queries /indexes - /monitoring - /security - /data-formats - /compatibility - /whats-new - /upgrade + Data Aggregation /aggregation + Queries & Indexes /indexes + Monitor Your Application /monitoring + Secure Your Data /security + Specialized Data Formats /data-formats + Compatibility /compatibility + What's New /whats-new + Upgrade Library Versions /upgrade FAQ - /reference + API Documentation /reference Overview -------- diff --git a/source/indexes.txt b/source/indexes.txt index 2e6d5ccf..d3f08d24 100644 --- a/source/indexes.txt +++ b/source/indexes.txt @@ -22,11 +22,11 @@ Optimize Queries by Using Indexes :titlesonly: :maxdepth: 1 - /indexes/index-mgmt - /indexes/single-field-index - /indexes/compound-index - /indexes/multikey-index - /indexes/atlas-search-index + Index Management /indexes/index-mgmt + Single Field /indexes/single-field-index + Compound /indexes/compound-index + Multikey /indexes/multikey-index + Atlas Search /indexes/atlas-search-index Overview -------- diff --git a/source/monitoring.txt b/source/monitoring.txt index 5322004f..2546f41f 100644 --- a/source/monitoring.txt +++ b/source/monitoring.txt @@ -7,7 +7,7 @@ Monitor Your Application .. toctree:: :caption: Monitoring categories - /monitoring/cluster-monitoring + Custer Monitoring /monitoring/cluster-monitoring .. /monitoring/command-monitoring .. /monitoring/connection-monitoring diff --git a/source/read.txt b/source/read.txt index 1e01ef17..16d3b5dc 100644 --- a/source/read.txt +++ b/source/read.txt @@ -22,14 +22,14 @@ Read Data from MongoDB :titlesonly: :maxdepth: 1 - /read/retrieve - /read/project - /read/cursor - /read/count - /read/specify-documents-to-return - /read/specify-a-query - /read/distinct - /read/change-streams + Retrieve Data /read/retrieve + Specify Fields to Return /read/project + Access Data from a Cursor /read/cursor + Count Documents /read/count + Specify Documents to Return /read/specify-documents-to-return + Specify a Query /read/specify-a-query + Retrieve Distinct Field Values /read/distinct + Monitor Data Changes /read/change-streams Overview -------- diff --git a/source/reference.txt b/source/reference.txt index 2ca87a2a..e1637564 100644 --- a/source/reference.txt +++ b/source/reference.txt @@ -6,11 +6,11 @@ API Documentation .. toctree:: :titlesonly: - /reference/bson - /reference/class/MongoDBClient - /reference/class/MongoDBDatabase - /reference/class/MongoDBCollection - /reference/class/MongoDBGridFSBucket - /reference/result-classes - /reference/functions - /reference/exception-classes + BSON /reference/bson + MongoDB\Client /reference/class/MongoDBClient + MongoDB\Database /reference/class/MongoDBDatabase + MongoDB\Collection /reference/class/MongoDBCollection + MongoDB\GridFS\Bucket /reference/class/MongoDBGridFSBucket + Result Classes /reference/result-classes + Functions /reference/functions + Exception /reference/exception-classes diff --git a/source/reference/result-classes.txt b/source/reference/result-classes.txt index 7836b48f..db2a1b66 100644 --- a/source/reference/result-classes.txt +++ b/source/reference/result-classes.txt @@ -5,12 +5,12 @@ Result Classes .. toctree:: :titlesonly: - BulkWriteResult Class - DeleteResult Class - InsertManyResult Class - InsertOneResult Class - UpdateResult Class - ChangeStream Class - CollectionInfo Class - DatabaseInfo Class - IndexInfo Class + BulkWriteResult + DeleteResult + InsertManyResult + InsertOneResult + UpdateResult + ChangeStream + CollectionInfo + DatabaseInfo + IndexInfo diff --git a/source/security.txt b/source/security.txt index 8c8e236b..29989d2c 100644 --- a/source/security.txt +++ b/source/security.txt @@ -22,8 +22,8 @@ Secure Your Data :titlesonly: :maxdepth: 1 - /security/authentication - /security/in-use-encryption + Authentication /security/authentication + Encryption /security/in-use-encryption Overview -------- diff --git a/source/write.txt b/source/write.txt index 8d9d16ca..0acfc360 100644 --- a/source/write.txt +++ b/source/write.txt @@ -22,13 +22,13 @@ Write Data to MongoDB :titlesonly: :maxdepth: 1 - /write/update - /write/insert - /write/delete - /write/replace - /write/bulk-write - /write/transaction - /write/gridfs + Update /write/update + Insert /write/insert + Delete /write/delete + Replace /write/replace + Bulk Write Operations /write/bulk-write + Perform a Transaction /write/transaction + Store Large Files /write/gridfs Overview -------- From faecb8521f4d902cba4091eb92cb029d9b6b0ec6 Mon Sep 17 00:00:00 2001 From: Lindsey Moore Date: Thu, 31 Oct 2024 17:50:58 -0400 Subject: [PATCH 3/7] angle brackets --- source/connect.txt | 10 +++++----- source/data-formats.txt | 8 ++++---- source/databases-collections.txt | 2 +- source/get-started.txt | 10 +++++----- source/index.txt | 30 +++++++++++++++--------------- source/indexes.txt | 10 +++++----- source/monitoring.txt | 2 +- source/read.txt | 16 ++++++++-------- source/reference.txt | 16 ++++++++-------- source/security.txt | 4 ++-- source/write.txt | 14 +++++++------- 11 files changed, 61 insertions(+), 61 deletions(-) diff --git a/source/connect.txt b/source/connect.txt index 8d0b0018..d45f506b 100644 --- a/source/connect.txt +++ b/source/connect.txt @@ -22,11 +22,11 @@ Connect to MongoDB :titlesonly: :maxdepth: 1 - Create a Client /connect/client - Specify Connection Options /connect/connection-options - Choose a Connection Target /connect/connection-targets - Configure TLS /connect/tls - Stable API /connect/stable-api + Create a Client + Specify Connection Options + Choose a Connection Target + Configure TLS + Stable API Overview -------- diff --git a/source/data-formats.txt b/source/data-formats.txt index 449ca6f1..c2cc3502 100644 --- a/source/data-formats.txt +++ b/source/data-formats.txt @@ -21,10 +21,10 @@ Specialized Data Formats :titlesonly: :maxdepth: 1 - Custom Data Types /data-formats/custom-types - Codecs /data-formats/codecs - Decimal128 /data-formats/decimal128 - BSON Data /data-formats/modeling-bson-data + Custom Data Types + Codecs + Decimal128 + BSON Data Overview -------- diff --git a/source/databases-collections.txt b/source/databases-collections.txt index 48013271..98d09bfe 100644 --- a/source/databases-collections.txt +++ b/source/databases-collections.txt @@ -21,7 +21,7 @@ Databases and Collections :titlesonly: :maxdepth: 1 - Time Series /databases-collections/time-series + Time Series Overview -------- diff --git a/source/get-started.txt b/source/get-started.txt index 1c914499..1f633dff 100644 --- a/source/get-started.txt +++ b/source/get-started.txt @@ -20,11 +20,11 @@ Get Started with the PHP Library .. toctree:: - Download and 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 to MongoDB /get-started/connect-to-mongodb/ - Next Steps /get-started/next-steps/ + Download and 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 def8c5f1..94415b2a 100644 --- a/source/index.txt +++ b/source/index.txt @@ -11,22 +11,22 @@ MongoDB PHP Library :titlesonly: Get Started - Connect to MongoDB /connect - Databases and Collections /databases-collections - Read Data /read - Write Data /write - CRUD Operations & Replica Sets /read-write-pref - Run a Database Command /run-command - Data Aggregation /aggregation - Queries & Indexes /indexes - Monitor Your Application /monitoring - Secure Your Data /security - Specialized Data Formats /data-formats - Compatibility /compatibility - What's New /whats-new - Upgrade Library Versions /upgrade + Connect to MongoDB + Databases and Collections + Read Data + Write Data + CRUD Operations & Replica Sets + Run a Database Command + Data Aggregation + Queries & Indexes + Monitor Your Application + Secure Your Data + Specialized Data Formats + Compatibility + What's New + Upgrade Library Versions FAQ - API Documentation /reference + API Documentation Overview -------- diff --git a/source/indexes.txt b/source/indexes.txt index d3f08d24..4a00ee8f 100644 --- a/source/indexes.txt +++ b/source/indexes.txt @@ -22,11 +22,11 @@ Optimize Queries by Using Indexes :titlesonly: :maxdepth: 1 - Index Management /indexes/index-mgmt - Single Field /indexes/single-field-index - Compound /indexes/compound-index - Multikey /indexes/multikey-index - Atlas Search /indexes/atlas-search-index + Index Management + Single Field + Compound + Multikey + Atlas Search Overview -------- diff --git a/source/monitoring.txt b/source/monitoring.txt index 2546f41f..ea6f6af5 100644 --- a/source/monitoring.txt +++ b/source/monitoring.txt @@ -7,7 +7,7 @@ Monitor Your Application .. toctree:: :caption: Monitoring categories - Custer Monitoring /monitoring/cluster-monitoring + Custer Monitoring .. /monitoring/command-monitoring .. /monitoring/connection-monitoring diff --git a/source/read.txt b/source/read.txt index 16d3b5dc..b5ba8376 100644 --- a/source/read.txt +++ b/source/read.txt @@ -22,14 +22,14 @@ Read Data from MongoDB :titlesonly: :maxdepth: 1 - Retrieve Data /read/retrieve - Specify Fields to Return /read/project - Access Data from a Cursor /read/cursor - Count Documents /read/count - Specify Documents to Return /read/specify-documents-to-return - Specify a Query /read/specify-a-query - Retrieve Distinct Field Values /read/distinct - Monitor Data Changes /read/change-streams + Retrieve Data + Specify Fields to Return + Access Data from a Cursor + Count Documents + Specify Documents to Return + Specify a Query + Retrieve Distinct Field Values + Monitor Data Changes Overview -------- diff --git a/source/reference.txt b/source/reference.txt index e1637564..5838c2e3 100644 --- a/source/reference.txt +++ b/source/reference.txt @@ -6,11 +6,11 @@ API Documentation .. toctree:: :titlesonly: - BSON /reference/bson - MongoDB\Client /reference/class/MongoDBClient - MongoDB\Database /reference/class/MongoDBDatabase - MongoDB\Collection /reference/class/MongoDBCollection - MongoDB\GridFS\Bucket /reference/class/MongoDBGridFSBucket - Result Classes /reference/result-classes - Functions /reference/functions - Exception /reference/exception-classes + BSON + MongoDB\Client + MongoDB\Database + MongoDB\Collection + MongoDB\GridFS\Bucket + Result Classes + Functions + Exception diff --git a/source/security.txt b/source/security.txt index 29989d2c..249ae009 100644 --- a/source/security.txt +++ b/source/security.txt @@ -22,8 +22,8 @@ Secure Your Data :titlesonly: :maxdepth: 1 - Authentication /security/authentication - Encryption /security/in-use-encryption + Authentication + Encryption Overview -------- diff --git a/source/write.txt b/source/write.txt index 0acfc360..bde6fbe6 100644 --- a/source/write.txt +++ b/source/write.txt @@ -22,13 +22,13 @@ Write Data to MongoDB :titlesonly: :maxdepth: 1 - Update /write/update - Insert /write/insert - Delete /write/delete - Replace /write/replace - Bulk Write Operations /write/bulk-write - Perform a Transaction /write/transaction - Store Large Files /write/gridfs + Update + Insert + Delete + Replace + Bulk Write Operations + Perform a Transaction + Store Large Files Overview -------- From 2bc1a34f2758b1b16252be62e29daa0c6792c219 Mon Sep 17 00:00:00 2001 From: Lindsey Moore Date: Thu, 31 Oct 2024 17:58:52 -0400 Subject: [PATCH 4/7] fixes --- source/monitoring.txt | 2 +- source/reference.txt | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/source/monitoring.txt b/source/monitoring.txt index ea6f6af5..43d15f27 100644 --- a/source/monitoring.txt +++ b/source/monitoring.txt @@ -7,7 +7,7 @@ Monitor Your Application .. toctree:: :caption: Monitoring categories - Custer Monitoring + Cluster Monitoring .. /monitoring/command-monitoring .. /monitoring/connection-monitoring diff --git a/source/reference.txt b/source/reference.txt index 5838c2e3..7127505b 100644 --- a/source/reference.txt +++ b/source/reference.txt @@ -13,4 +13,4 @@ API Documentation MongoDB\GridFS\Bucket Result Classes Functions - Exception + Exception Classes From 0cdc36dec703782a83b9212a286cb3d82df0d1f8 Mon Sep 17 00:00:00 2001 From: Lindsey Moore Date: Fri, 1 Nov 2024 10:58:21 -0400 Subject: [PATCH 5/7] internal review --- source/data-formats.txt | 2 +- source/write.txt | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/source/data-formats.txt b/source/data-formats.txt index c2cc3502..550c2d64 100644 --- a/source/data-formats.txt +++ b/source/data-formats.txt @@ -24,7 +24,7 @@ Specialized Data Formats Custom Data Types Codecs Decimal128 - BSON Data + BSON Overview -------- diff --git a/source/write.txt b/source/write.txt index bde6fbe6..3114e42f 100644 --- a/source/write.txt +++ b/source/write.txt @@ -27,7 +27,7 @@ Write Data to MongoDB Delete Replace Bulk Write Operations - Perform a Transaction + Transactions Store Large Files Overview From 0f44fe2d3011293cd2d09a5dc9854496b706ce98 Mon Sep 17 00:00:00 2001 From: Lindsey Moore Date: Fri, 1 Nov 2024 17:11:33 -0400 Subject: [PATCH 6/7] updates based on Mike's PR --- source/index.txt | 2 +- source/read.txt | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/source/index.txt b/source/index.txt index 94415b2a..0677232f 100644 --- a/source/index.txt +++ b/source/index.txt @@ -18,7 +18,7 @@ MongoDB PHP Library CRUD Operations & Replica Sets Run a Database Command Data Aggregation - Queries & Indexes + Indexes Monitor Your Application Secure Your Data Specialized Data Formats diff --git a/source/read.txt b/source/read.txt index b5ba8376..1f7c9296 100644 --- a/source/read.txt +++ b/source/read.txt @@ -28,8 +28,8 @@ Read Data from MongoDB Count Documents Specify Documents to Return Specify a Query - Retrieve Distinct Field Values - Monitor Data Changes + Distinct Field Values + Monitor Changes Overview -------- From 9840e62907a74a95fdfd11392ae70f91c2aa12dd Mon Sep 17 00:00:00 2001 From: Lindsey Moore Date: Mon, 4 Nov 2024 15:43:10 -0500 Subject: [PATCH 7/7] review comments and consistency --- source/get-started.txt | 2 +- source/index.txt | 6 +++--- source/indexes.txt | 6 +++--- 3 files changed, 7 insertions(+), 7 deletions(-) diff --git a/source/get-started.txt b/source/get-started.txt index 1f633dff..9cfd031c 100644 --- a/source/get-started.txt +++ b/source/get-started.txt @@ -20,7 +20,7 @@ Get Started with the PHP Library .. toctree:: - Download and Install + Download & Install Create a Deployment Create a Connection String Connect to MongoDB diff --git a/source/index.txt b/source/index.txt index 0677232f..d1df02fa 100644 --- a/source/index.txt +++ b/source/index.txt @@ -12,7 +12,7 @@ MongoDB PHP Library Get Started Connect to MongoDB - Databases and Collections + Databases & Collections Read Data Write Data CRUD Operations & Replica Sets @@ -20,11 +20,11 @@ MongoDB PHP Library Data Aggregation Indexes Monitor Your Application - Secure Your Data + Security Specialized Data Formats Compatibility What's New - Upgrade Library Versions + Upgrade FAQ API Documentation diff --git a/source/indexes.txt b/source/indexes.txt index 4a00ee8f..29afd6ed 100644 --- a/source/indexes.txt +++ b/source/indexes.txt @@ -23,9 +23,9 @@ Optimize Queries by Using Indexes :maxdepth: 1 Index Management - Single Field - Compound - Multikey + Single Field Indexes + Compound Indexes + Multikey Indexes Atlas Search Overview