From b561bef358aeb0c52bee8638aefa7e2597db5464 Mon Sep 17 00:00:00 2001 From: Nick Larew Date: Thu, 10 Apr 2025 17:39:08 -0500 Subject: [PATCH] Add missing meta descriptions --- source/api-documentation.txt | 3 +++ source/compatibility.txt | 3 +++ source/connection-troubleshooting.txt | 3 +++ source/faq.txt | 1 + source/fundamentals/aggregation-expression-operations.txt | 3 +++ source/fundamentals/aggregation.txt | 3 +++ source/fundamentals/auth.txt | 3 +++ source/fundamentals/builders.txt | 3 +++ source/fundamentals/collations.txt | 3 +++ source/fundamentals/connection.txt | 3 +++ source/fundamentals/crud.txt | 3 +++ source/fundamentals/data-formats.txt | 3 +++ source/fundamentals/databases-collections.txt | 3 +++ source/fundamentals/indexes.txt | 1 + source/fundamentals/logging.txt | 3 +++ source/fundamentals/monitoring.txt | 3 +++ source/fundamentals/stable-api.txt | 3 +++ source/fundamentals/time-series.txt | 3 +++ source/index.txt | 3 +++ source/issues-and-help.txt | 1 + source/quick-reference.txt | 3 +++ source/quick-start.txt | 1 + source/usage-examples.txt | 3 +++ source/whats-new.txt | 3 +++ 24 files changed, 64 insertions(+) diff --git a/source/api-documentation.txt b/source/api-documentation.txt index c0211098..07daf3bb 100644 --- a/source/api-documentation.txt +++ b/source/api-documentation.txt @@ -2,6 +2,9 @@ API Documentation ================= +.. meta:: + :description: Explore the API documentation for Kotlin, including BSON serialization, driver extensions, core functionality, and coroutine and sync drivers. + .. toctree:: :titlesonly: :maxdepth: 1 diff --git a/source/compatibility.txt b/source/compatibility.txt index 42693187..fd507f1b 100644 --- a/source/compatibility.txt +++ b/source/compatibility.txt @@ -4,6 +4,9 @@ Compatibility ============= +.. meta:: + :description: Check the recommended versions of the MongoDB Kotlin Driver for compatibility with specific MongoDB and Kotlin versions. + .. contents:: On this page :local: :backlinks: none diff --git a/source/connection-troubleshooting.txt b/source/connection-troubleshooting.txt index 1d2d7e2b..a2ac88cd 100644 --- a/source/connection-troubleshooting.txt +++ b/source/connection-troubleshooting.txt @@ -4,6 +4,9 @@ Connection Troubleshooting ========================== +.. meta:: + :description: Troubleshoot connection issues with the MongoDB Kotlin Driver by checking connection strings, configuring firewalls, and verifying authentication settings. + .. contents:: On this page :local: :backlinks: none diff --git a/source/faq.txt b/source/faq.txt index 6443300f..7377479c 100644 --- a/source/faq.txt +++ b/source/faq.txt @@ -10,6 +10,7 @@ FAQ .. meta:: :keywords: troubleshooting, question, support + :description: Find answers to common questions about the Kotlin driver, including connection issues, differences from KMongo, and connection pooling. .. contents:: On this page :local: diff --git a/source/fundamentals/aggregation-expression-operations.txt b/source/fundamentals/aggregation-expression-operations.txt index c3e7c87f..253af6d2 100644 --- a/source/fundamentals/aggregation-expression-operations.txt +++ b/source/fundamentals/aggregation-expression-operations.txt @@ -4,6 +4,9 @@ Aggregation Expression Operations ================================= +.. meta:: + :description: Learn to use the MongoDB Kotlin Driver for constructing aggregation expressions with typesafe Java methods, enhancing readability and functionality. + .. contents:: On this page :local: :backlinks: none diff --git a/source/fundamentals/aggregation.txt b/source/fundamentals/aggregation.txt index d3913e9a..7111af22 100644 --- a/source/fundamentals/aggregation.txt +++ b/source/fundamentals/aggregation.txt @@ -4,6 +4,9 @@ Aggregation =========== +.. meta:: + :description: Learn to use aggregation operations in the MongoDB Kotlin driver to process data and return computed results using the aggregation pipeline. + .. contents:: On this page :local: :backlinks: none diff --git a/source/fundamentals/auth.txt b/source/fundamentals/auth.txt index 237805ef..a633e970 100644 --- a/source/fundamentals/auth.txt +++ b/source/fundamentals/auth.txt @@ -4,6 +4,9 @@ Authentication Mechanisms ========================= +.. meta:: + :description: Learn how to authenticate with MongoDB using various mechanisms like SCRAM-SHA-256, MONGODB-AWS, and X.509, and configure connections with Kotlin. + .. contents:: On this page :local: :backlinks: none diff --git a/source/fundamentals/builders.txt b/source/fundamentals/builders.txt index 254413a1..59ad31b8 100644 --- a/source/fundamentals/builders.txt +++ b/source/fundamentals/builders.txt @@ -4,6 +4,9 @@ Builders ======== +.. meta:: + :description: Explore how to use Kotlin driver builder classes for efficient CRUD operations and aggregation, enhancing error detection and code completion in your IDE. + .. toctree:: Aggregation diff --git a/source/fundamentals/collations.txt b/source/fundamentals/collations.txt index 8d3428b0..6d5b9746 100644 --- a/source/fundamentals/collations.txt +++ b/source/fundamentals/collations.txt @@ -2,6 +2,9 @@ Collations ========== +.. meta:: + :description: Learn how to use collations in MongoDB to order query results by string values, including specifying collations for collections, indexes, and operations. + .. contents:: On this page :local: :backlinks: none diff --git a/source/fundamentals/connection.txt b/source/fundamentals/connection.txt index db49932d..d35eb0c8 100644 --- a/source/fundamentals/connection.txt +++ b/source/fundamentals/connection.txt @@ -4,6 +4,9 @@ Connection Guide ================ +.. meta:: + :description: Explore how to set up and configure a connection to a MongoDB deployment using the Kotlin Coroutine driver, including options for network compression and TLS/SSL. + .. toctree:: Connect to MongoDB diff --git a/source/fundamentals/crud.txt b/source/fundamentals/crud.txt index ea152d08..49f18969 100644 --- a/source/fundamentals/crud.txt +++ b/source/fundamentals/crud.txt @@ -4,6 +4,9 @@ CRUD Operations =============== +.. meta:: + :description: Explore how to perform CRUD operations using Kotlin Coroutine with MongoDB, including creating, reading, updating, and deleting documents. + .. toctree:: :caption: CRUD Operations diff --git a/source/fundamentals/data-formats.txt b/source/fundamentals/data-formats.txt index 5737e098..b2996616 100644 --- a/source/fundamentals/data-formats.txt +++ b/source/fundamentals/data-formats.txt @@ -2,6 +2,9 @@ Data Formats ============ +.. meta:: + :description: Explore various data formats in Kotlin, including BSON, Extended JSON, and Kotlin Serialization, and learn about codecs and document data formats. + .. toctree:: :caption: Data Formats diff --git a/source/fundamentals/databases-collections.txt b/source/fundamentals/databases-collections.txt index 773288cf..26e52adf 100644 --- a/source/fundamentals/databases-collections.txt +++ b/source/fundamentals/databases-collections.txt @@ -2,6 +2,9 @@ Databases and Collections ========================= +.. meta:: + :description: Learn to use MongoDB databases and collections with the Kotlin driver, including accessing, creating, and managing collections and specifying read/write concerns. + .. contents:: On this page :local: :backlinks: none diff --git a/source/fundamentals/indexes.txt b/source/fundamentals/indexes.txt index 0084ea27..05928e1f 100644 --- a/source/fundamentals/indexes.txt +++ b/source/fundamentals/indexes.txt @@ -10,6 +10,7 @@ Indexes .. meta:: :keywords: code example, optimization, atlas search + :description: Learn to create and manage indexes using the MongoDB Kotlin Driver to optimize query performance and support various query types. .. contents:: On this page :local: diff --git a/source/fundamentals/logging.txt b/source/fundamentals/logging.txt index efbc4509..5cd074a8 100644 --- a/source/fundamentals/logging.txt +++ b/source/fundamentals/logging.txt @@ -4,6 +4,9 @@ Logging ======= +.. meta:: + :description: Learn how to set up and configure logging in the MongoDB Kotlin driver using SLF4J, including setting log levels and logger names. + .. contents:: On this page :local: :backlinks: none diff --git a/source/fundamentals/monitoring.txt b/source/fundamentals/monitoring.txt index 7c1de3e9..d9ce973b 100644 --- a/source/fundamentals/monitoring.txt +++ b/source/fundamentals/monitoring.txt @@ -2,6 +2,9 @@ Monitoring ========== +.. meta:: + :description: Learn how to set up and configure monitoring in the MongoDB Kotlin driver to track resource usage and performance. + .. contents:: On this page :local: :backlinks: none diff --git a/source/fundamentals/stable-api.txt b/source/fundamentals/stable-api.txt index 521df9a1..6f87eb21 100644 --- a/source/fundamentals/stable-api.txt +++ b/source/fundamentals/stable-api.txt @@ -5,6 +5,9 @@ {+stable-api+} ============== +.. meta:: + :description: Learn how to enable and configure the Stable API feature in MongoDB to ensure compatibility with specified API versions when connecting to a server. + .. contents:: On this page :local: :backlinks: none diff --git a/source/fundamentals/time-series.txt b/source/fundamentals/time-series.txt index 060e57a4..43122da0 100644 --- a/source/fundamentals/time-series.txt +++ b/source/fundamentals/time-series.txt @@ -2,6 +2,9 @@ Time Series Collections ======================= +.. meta:: + :description: Learn how to create and query time series collections using the MongoDB Kotlin driver, including setting up collection options and using window functions for data aggregation. + .. contents:: On this page :local: :backlinks: none diff --git a/source/index.txt b/source/index.txt index 5128b0dd..b2f74ecc 100644 --- a/source/index.txt +++ b/source/index.txt @@ -2,6 +2,9 @@ MongoDB Kotlin Driver ===================== +.. meta:: + :description: Explore the MongoDB Kotlin Driver for server-side applications using coroutines, including setup, usage examples, and troubleshooting. + .. toctree:: :titlesonly: :maxdepth: 1 diff --git a/source/issues-and-help.txt b/source/issues-and-help.txt index 9323000c..41af1d1c 100644 --- a/source/issues-and-help.txt +++ b/source/issues-and-help.txt @@ -10,6 +10,7 @@ Issues & Help .. meta:: :keywords: kotlin coroutine, troubleshooting, feedback + :description: Find support for the Kotlin driver through the MongoDB Community Forums, report issues via Jira, or contribute improvements with pull requests. .. contents:: On this page :local: diff --git a/source/quick-reference.txt b/source/quick-reference.txt index d65a6ab4..3b068d5b 100644 --- a/source/quick-reference.txt +++ b/source/quick-reference.txt @@ -4,6 +4,9 @@ Quick Reference =============== +.. meta:: + :description: Explore Kotlin Coroutine driver syntax for MongoDB commands, including find, insert, update, delete, and more, with examples and API documentation links. + This page shows the driver syntax for several MongoDB commands and links to their related reference and API documentation. diff --git a/source/quick-start.txt b/source/quick-start.txt index d4bb58a0..85dc96a0 100644 --- a/source/quick-start.txt +++ b/source/quick-start.txt @@ -10,6 +10,7 @@ Kotlin Driver Quick Start .. meta:: :keywords: code example, get started, runnable app + :description: Learn to connect a Kotlin application to a MongoDB Atlas cluster using the Kotlin driver, including setup, dependencies, and querying sample data. .. contents:: On this page :local: diff --git a/source/usage-examples.txt b/source/usage-examples.txt index 56cb08d2..70306df2 100644 --- a/source/usage-examples.txt +++ b/source/usage-examples.txt @@ -2,6 +2,9 @@ Usage Examples ============== +.. meta:: + :description: Explore Kotlin usage examples for popular MongoDB operations, including setup instructions and sample code for easy integration. + .. contents:: On this page :local: :backlinks: none diff --git a/source/whats-new.txt b/source/whats-new.txt index e3d7c6ef..7aaa605a 100644 --- a/source/whats-new.txt +++ b/source/whats-new.txt @@ -4,6 +4,9 @@ What's New ========== +.. meta:: + :description: Discover the latest features, improvements, and fixes in recent Kotlin driver versions, including new classes, API changes, and enhanced support for various MongoDB functionalities. + .. contents:: On this page :local: :backlinks: none