From 22d12fe1cc921ae537d30f92f3940ec97d2e99e0 Mon Sep 17 00:00:00 2001 From: Nick Larew Date: Thu, 10 Apr 2025 17:40:37 -0500 Subject: [PATCH] Add missing meta descriptions --- source/compatibility.txt | 1 + source/connection-troubleshooting.txt | 3 +++ source/faq.txt | 1 + source/fundamentals/aggregation.txt | 1 + source/fundamentals/atlas-search.txt | 1 + source/fundamentals/authentication.txt | 1 + source/fundamentals/bson.txt | 3 +++ source/fundamentals/builders.txt | 1 + source/fundamentals/connection.txt | 3 +++ source/fundamentals/connection/connect.txt | 1 + source/fundamentals/connection/connection-options.txt | 1 + source/fundamentals/connection/network-compression.txt | 3 +++ source/fundamentals/connection/tls.txt | 3 +++ source/fundamentals/crud/read-operations/retrieve.txt | 1 + source/fundamentals/crud/write-operations/delete.txt | 3 +++ source/fundamentals/crud/write-operations/insert.txt | 1 + source/fundamentals/database-collection.txt | 1 + source/fundamentals/geo.txt | 1 + source/fundamentals/indexes.txt | 1 + source/fundamentals/linq.txt | 1 + source/fundamentals/logging.txt | 1 + source/fundamentals/serialization.txt | 1 + source/fundamentals/serialization/poco.txt | 1 + source/fundamentals/specify-query.txt | 3 +++ source/fundamentals/stable-api.txt | 3 +++ source/fundamentals/time-series.txt | 3 +++ source/fundamentals/transactions.txt | 1 + source/index.txt | 1 + source/issues-and-help.txt | 3 +++ source/previous-versions.txt | 3 +++ source/quick-reference.txt | 3 +++ source/quick-start.txt | 1 + source/upgrade.txt | 1 + source/usage-examples.txt | 1 + source/usage-examples/deleteMany.txt | 1 + source/usage-examples/deleteOne.txt | 1 + source/usage-examples/findMany.txt | 1 + source/usage-examples/findOne.txt | 1 + source/usage-examples/insertMany.txt | 1 + source/usage-examples/insertOne.txt | 1 + source/usage-examples/replaceOne.txt | 1 + source/usage-examples/updateMany.txt | 1 + source/usage-examples/updateOne.txt | 1 + source/whats-new.txt | 1 + 44 files changed, 68 insertions(+) diff --git a/source/compatibility.txt b/source/compatibility.txt index ce124f4b..935ebcc8 100644 --- a/source/compatibility.txt +++ b/source/compatibility.txt @@ -16,6 +16,7 @@ Compatibility .. meta:: :keywords: backwards compatibility, versions, upgrade, .NET + :description: Check the recommended MongoDB .NET/C# Driver versions for compatibility with specific MongoDB and .NET versions. MongoDB Compatibility --------------------- diff --git a/source/connection-troubleshooting.txt b/source/connection-troubleshooting.txt index 6e0877a6..68505cca 100644 --- a/source/connection-troubleshooting.txt +++ b/source/connection-troubleshooting.txt @@ -4,6 +4,9 @@ Connection Troubleshooting ========================== +.. meta:: + :description: Troubleshoot connection issues with the .NET/C# Driver for MongoDB by checking connection strings, firewall settings, authentication, and connection pool limits. + .. contents:: On this page :local: :backlinks: none diff --git a/source/faq.txt b/source/faq.txt index 5a2edad0..a838d20b 100644 --- a/source/faq.txt +++ b/source/faq.txt @@ -16,6 +16,7 @@ Frequently Asked Questions .. meta:: :keywords: .NET, questions, errors, problems + :description: Find answers to common questions about the C# driver, including connection pooling, server selection timeouts, and serialization options. This page contains frequently asked questions and their corresponding answers. diff --git a/source/fundamentals/aggregation.txt b/source/fundamentals/aggregation.txt index 735210f7..879c0a8d 100644 --- a/source/fundamentals/aggregation.txt +++ b/source/fundamentals/aggregation.txt @@ -10,6 +10,7 @@ Aggregation .. meta:: :keywords: code example, transform, pipeline + :description: Learn to perform aggregation operations using the MongoDB .NET/C# Driver, including examples with LINQ, Builders, and BsonDocument approaches. .. contents:: On this page :local: diff --git a/source/fundamentals/atlas-search.txt b/source/fundamentals/atlas-search.txt index 3a845f2f..99fdc0bd 100644 --- a/source/fundamentals/atlas-search.txt +++ b/source/fundamentals/atlas-search.txt @@ -10,6 +10,7 @@ Atlas Search .. meta:: :keywords: .NET, operators, aggregation, pipeline, atlas, code example + :description: Learn to use the `Search` builder for creating `$search` aggregation pipeline stages with the .NET/C# Driver in Atlas Search. .. contents:: On this page :local: diff --git a/source/fundamentals/authentication.txt b/source/fundamentals/authentication.txt index e6a52726..ca4b26ef 100644 --- a/source/fundamentals/authentication.txt +++ b/source/fundamentals/authentication.txt @@ -16,6 +16,7 @@ Authentication Mechanisms .. meta:: :keywords: .NET, community, security + :description: Learn how to authenticate to MongoDB using various authentication mechanisms compatible with different MongoDB Server editions. .. toctree:: :caption: Authentication diff --git a/source/fundamentals/bson.txt b/source/fundamentals/bson.txt index e04523f2..2ede326c 100644 --- a/source/fundamentals/bson.txt +++ b/source/fundamentals/bson.txt @@ -4,6 +4,9 @@ BSON Operations =============== +.. meta:: + :description: Learn how to create, modify, write, and read BSON documents using the .NET/C# Driver, including handling BSON data format and file operations. + .. default-domain:: mongodb .. contents:: On this page diff --git a/source/fundamentals/builders.txt b/source/fundamentals/builders.txt index 39e58c76..14aeef19 100644 --- a/source/fundamentals/builders.txt +++ b/source/fundamentals/builders.txt @@ -16,6 +16,7 @@ Operations with Builders .. meta:: :keywords: aggregation, query, code example + :description: Learn to use builders in the .NET/C# Driver for MongoDB to create filters, projections, sorts, updates, and index keys, ensuring compile-time safety. Overview -------- diff --git a/source/fundamentals/connection.txt b/source/fundamentals/connection.txt index 3b0ec89a..63ad50e6 100644 --- a/source/fundamentals/connection.txt +++ b/source/fundamentals/connection.txt @@ -4,6 +4,9 @@ Connection ========== +.. meta:: + :description: Learn to connect your application to MongoDB using the .NET/C# Driver, including connection options and enabling TLS. + .. default-domain:: mongodb .. toctree:: diff --git a/source/fundamentals/connection/connect.txt b/source/fundamentals/connection/connect.txt index b3ecd163..68d5def2 100644 --- a/source/fundamentals/connection/connect.txt +++ b/source/fundamentals/connection/connect.txt @@ -10,6 +10,7 @@ Connection Guide .. meta:: :keywords: connection string, URI, server, Atlas, settings + :description: Connect to a MongoDB instance or replica set using the .NET/C# Driver by configuring a connection URI or `MongoClientSettings` for various deployment types. .. contents:: On this page :local: diff --git a/source/fundamentals/connection/connection-options.txt b/source/fundamentals/connection/connection-options.txt index 99ba50df..e5386b1b 100644 --- a/source/fundamentals/connection/connection-options.txt +++ b/source/fundamentals/connection/connection-options.txt @@ -10,6 +10,7 @@ Connection Options .. meta:: :keywords: connection string, URI, server, Atlas, settings, configure + :description: Explore MongoDB connection and authentication options in the .NET/C# Driver using connection URI or `MongoClientSettings` for flexible configuration. .. contents:: On this page :local: diff --git a/source/fundamentals/connection/network-compression.txt b/source/fundamentals/connection/network-compression.txt index 912d4a85..56e32dd8 100644 --- a/source/fundamentals/connection/network-compression.txt +++ b/source/fundamentals/connection/network-compression.txt @@ -4,6 +4,9 @@ Network Compression =================== +.. meta:: + :description: Enable network compression in the .NET/C# Driver to reduce data transfer using Snappy, Zlib, or Zstandard algorithms. + You can enable a driver option to compress messages, which reduces the amount of data passed over the network between MongoDB and your application. diff --git a/source/fundamentals/connection/tls.txt b/source/fundamentals/connection/tls.txt index 9cda5e47..2019cf98 100644 --- a/source/fundamentals/connection/tls.txt +++ b/source/fundamentals/connection/tls.txt @@ -4,6 +4,9 @@ Enable TLS on a Connection ========================== +.. meta:: + :description: Learn how to enable TLS/SSL for MongoDB connections using .NET/C# Driver, configure client certificates, and manage secure and insecure TLS settings. + .. contents:: On this page :local: :backlinks: none diff --git a/source/fundamentals/crud/read-operations/retrieve.txt b/source/fundamentals/crud/read-operations/retrieve.txt index c8eba926..d662fd76 100644 --- a/source/fundamentals/crud/read-operations/retrieve.txt +++ b/source/fundamentals/crud/read-operations/retrieve.txt @@ -16,6 +16,7 @@ Retrieve Data .. meta:: :keywords: code examples, read, search, cursor + :description: Learn to retrieve data from a MongoDB collection using the .NET/C# Driver with the `Find()` method, including examples for finding single or multiple documents. Overview -------- diff --git a/source/fundamentals/crud/write-operations/delete.txt b/source/fundamentals/crud/write-operations/delete.txt index 4c679bd4..8446ee53 100644 --- a/source/fundamentals/crud/write-operations/delete.txt +++ b/source/fundamentals/crud/write-operations/delete.txt @@ -4,6 +4,9 @@ Delete Documents ================ +.. meta:: + :description: Learn how to remove documents from MongoDB collections using delete operations like `DeleteOne()` and `DeleteMany()`, with examples and options. + .. default-domain:: mongodb .. contents:: On this page diff --git a/source/fundamentals/crud/write-operations/insert.txt b/source/fundamentals/crud/write-operations/insert.txt index db562689..6d623a84 100644 --- a/source/fundamentals/crud/write-operations/insert.txt +++ b/source/fundamentals/crud/write-operations/insert.txt @@ -16,6 +16,7 @@ Insert Documents .. meta:: :keywords: bulk, synchronous, asynchronous + :description: Learn to use the MongoDB .NET/C# Driver for inserting documents into a collection, with options for synchronous and asynchronous operations. Overview -------- diff --git a/source/fundamentals/database-collection.txt b/source/fundamentals/database-collection.txt index 4af4a3ac..d62658dc 100644 --- a/source/fundamentals/database-collection.txt +++ b/source/fundamentals/database-collection.txt @@ -10,6 +10,7 @@ Databases and Collections .. meta:: :keywords: access data, delete data, organize connections + :description: Learn how to use the .NET/C# Driver to manage MongoDB databases and collections, including accessing, listing, creating, and dropping them. .. contents:: On this page :local: diff --git a/source/fundamentals/geo.txt b/source/fundamentals/geo.txt index 951e3246..a530076d 100644 --- a/source/fundamentals/geo.txt +++ b/source/fundamentals/geo.txt @@ -10,6 +10,7 @@ Search Geospatially .. meta:: :keywords: code example, coordinates, location, geographic + :description: Learn to work with geospatial data in C# using GeoJSON and legacy formats, create geospatial indexes, and perform queries like proximity and polygon searches. .. contents:: On this page :local: diff --git a/source/fundamentals/indexes.txt b/source/fundamentals/indexes.txt index a2542b3c..ea04c6d8 100644 --- a/source/fundamentals/indexes.txt +++ b/source/fundamentals/indexes.txt @@ -10,6 +10,7 @@ Indexes .. meta:: :keywords: code example, Atlas search + :description: Learn how to use indexes with the MongoDB .NET/C# Driver to improve query efficiency and explore different index types like single field, compound, and geospatial indexes. .. contents:: On this page :local: diff --git a/source/fundamentals/linq.txt b/source/fundamentals/linq.txt index 8056737e..c159bb04 100644 --- a/source/fundamentals/linq.txt +++ b/source/fundamentals/linq.txt @@ -16,6 +16,7 @@ LINQ Syntax for Aggregation Operations .. meta:: :keywords: code example, query, aggregation + :description: Learn how to use LINQ with the MongoDB .NET/C# Driver to construct queries and perform aggregation operations on collections. Overview -------- diff --git a/source/fundamentals/logging.txt b/source/fundamentals/logging.txt index 258b2a91..653c66a7 100644 --- a/source/fundamentals/logging.txt +++ b/source/fundamentals/logging.txt @@ -10,6 +10,7 @@ Logging .. meta:: :keywords: loggerfactory, logger, audit + :description: Learn to configure logging in the .NET/C# Driver using the standard .NET logging API, including setting log verbosity and categories. .. contents:: On this page :local: diff --git a/source/fundamentals/serialization.txt b/source/fundamentals/serialization.txt index a3f8de15..25378904 100644 --- a/source/fundamentals/serialization.txt +++ b/source/fundamentals/serialization.txt @@ -10,6 +10,7 @@ Serialization .. meta:: :keywords: class, map, poco, polymorphism, guid, deserialize + :description: Learn to perform serialization with the .NET/C# Driver, including using serializers, custom serializers, and conventions for mapping C# objects to BSON documents. .. contents:: On this page :local: diff --git a/source/fundamentals/serialization/poco.txt b/source/fundamentals/serialization/poco.txt index a7fab8a5..57b199af 100644 --- a/source/fundamentals/serialization/poco.txt +++ b/source/fundamentals/serialization/poco.txt @@ -16,6 +16,7 @@ POCOs .. meta:: :keywords: .NET, object, custom class, attributes, code example + :description: Learn how to use POCOs with the .NET/C# Driver for MongoDB, including creating, serializing, and customizing field mapping and serialization behavior. Overview -------- diff --git a/source/fundamentals/specify-query.txt b/source/fundamentals/specify-query.txt index 22bfa38b..fbb2d4a6 100644 --- a/source/fundamentals/specify-query.txt +++ b/source/fundamentals/specify-query.txt @@ -4,6 +4,9 @@ Specify a Query =============== +.. meta:: + :description: Learn how to specify queries using the MongoDB .NET/C# Driver, including creating query filters and using comparison, logical, array, element, and evaluation operators. + .. contents:: On this page :local: :backlinks: none diff --git a/source/fundamentals/stable-api.txt b/source/fundamentals/stable-api.txt index 5417a318..66384d50 100644 --- a/source/fundamentals/stable-api.txt +++ b/source/fundamentals/stable-api.txt @@ -4,6 +4,9 @@ {+stable-api+} ============== +.. meta:: + :description: Learn how to specify Stable API compatibility in the MongoDB .NET/C# Driver to ensure consistent server responses and long-term API stability. + .. default-domain:: mongodb .. contents:: On this page diff --git a/source/fundamentals/time-series.txt b/source/fundamentals/time-series.txt index b1b2e6c0..c4238f67 100644 --- a/source/fundamentals/time-series.txt +++ b/source/fundamentals/time-series.txt @@ -4,6 +4,9 @@ Time Series Collections ======================= +.. meta:: + :description: Learn to use time series collections in MongoDB with the .NET/C# Driver, including creating and querying collections for efficient data storage. + .. contents:: On this page :local: :backlinks: none diff --git a/source/fundamentals/transactions.txt b/source/fundamentals/transactions.txt index 92b22d8e..07b9b68b 100644 --- a/source/fundamentals/transactions.txt +++ b/source/fundamentals/transactions.txt @@ -10,6 +10,7 @@ Transactions .. meta:: :keywords: code example, multi-document + :description: Learn to perform transactions using the MongoDB .NET/C# Driver, ensuring data consistency and handling errors with session-based operations. .. contents:: On this page :local: diff --git a/source/index.txt b/source/index.txt index d852dbca..95be5811 100644 --- a/source/index.txt +++ b/source/index.txt @@ -8,6 +8,7 @@ MongoDB C# Driver .. meta:: :keywords: dotnet + :description: Explore the MongoDB .NET/C# Driver to connect and work with MongoDB, featuring quick start guides, usage examples, and compatibility information. .. toctree:: diff --git a/source/issues-and-help.txt b/source/issues-and-help.txt index b03aa4c4..9a71b088 100644 --- a/source/issues-and-help.txt +++ b/source/issues-and-help.txt @@ -4,6 +4,9 @@ Issues & Help ============= +.. meta:: + :description: Find support for the .NET/C# Driver through community forums, report bugs or request features via JIRA, and contribute to the driver with pull requests. + .. default-domain:: mongodb We are lucky to have a vibrant community of {+driver-long+} diff --git a/source/previous-versions.txt b/source/previous-versions.txt index 1fdfc547..33b0af5d 100644 --- a/source/previous-versions.txt +++ b/source/previous-versions.txt @@ -4,6 +4,9 @@ Previous Versions ================= +.. meta:: + :description: Access documentation for previous versions of the C# driver, including versions 2.0 through 2.18. + The following links direct you to documentation for previous versions of the driver. diff --git a/source/quick-reference.txt b/source/quick-reference.txt index 5223b826..75c9113d 100644 --- a/source/quick-reference.txt +++ b/source/quick-reference.txt @@ -4,6 +4,9 @@ Quick Reference =============== +.. meta:: + :description: Explore C# driver syntax for MongoDB commands, including find, insert, update, delete, and more, with links to API documentation and usage examples. + 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 96690d2c..f56110bd 100644 --- a/source/quick-start.txt +++ b/source/quick-start.txt @@ -10,6 +10,7 @@ Quick Start .. meta:: :keywords: set up, runnable app, initialize, connect + :description: Connect your .NET application to a MongoDB Atlas cluster using the .NET/C# Driver, and run queries on sample data. .. contents:: On this page :local: diff --git a/source/upgrade.txt b/source/upgrade.txt index fd55892c..e4fc97f8 100644 --- a/source/upgrade.txt +++ b/source/upgrade.txt @@ -10,6 +10,7 @@ Upgrade Driver Versions .. meta:: :keywords: update, breaking change, releases + :description: Identify potential breaking changes when upgrading .NET/C# Driver versions and learn how to minimize application changes using the Stable API. .. contents:: On this page :local: diff --git a/source/usage-examples.txt b/source/usage-examples.txt index 38dc7079..43669717 100644 --- a/source/usage-examples.txt +++ b/source/usage-examples.txt @@ -10,6 +10,7 @@ Usage Examples .. meta:: :keywords: code, .NET, operation + :description: Explore C# usage examples for MongoDB operations, including synchronous and asynchronous code snippets, using sample datasets and custom serialization. .. contents:: On this page :local: diff --git a/source/usage-examples/deleteMany.txt b/source/usage-examples/deleteMany.txt index 952ad41c..d2d16dbc 100644 --- a/source/usage-examples/deleteMany.txt +++ b/source/usage-examples/deleteMany.txt @@ -10,6 +10,7 @@ Delete Many Documents .. meta:: :keywords: code example, .NET, operation + :description: Delete multiple documents in a collection using the `DeleteMany()` or `DeleteManyAsync()` methods in C#. .. contents:: On this page :local: diff --git a/source/usage-examples/deleteOne.txt b/source/usage-examples/deleteOne.txt index b760395f..5dcfac68 100644 --- a/source/usage-examples/deleteOne.txt +++ b/source/usage-examples/deleteOne.txt @@ -10,6 +10,7 @@ Delete a Document .. meta:: :keywords: code example, .NET, operation + :description: Learn how to delete a document from a collection using the synchronous `DeleteOne()` or asynchronous `DeleteOneAsync()` methods in C#. .. contents:: On this page :local: diff --git a/source/usage-examples/findMany.txt b/source/usage-examples/findMany.txt index 4236f3c1..ab07a068 100644 --- a/source/usage-examples/findMany.txt +++ b/source/usage-examples/findMany.txt @@ -10,6 +10,7 @@ Find Multiple Documents .. meta:: :keywords: code example, .NET, operation + :description: Retrieve multiple documents from a collection using the `Find()` method in C# with examples for both asynchronous and synchronous operations. .. contents:: On this page :local: diff --git a/source/usage-examples/findOne.txt b/source/usage-examples/findOne.txt index 5b4401a7..3b167dfa 100644 --- a/source/usage-examples/findOne.txt +++ b/source/usage-examples/findOne.txt @@ -10,6 +10,7 @@ Find a Document .. meta:: :keywords: code example, .NET, operation + :description: Retrieve a document from a collection using the `Find()` method in C# with examples for both asynchronous and synchronous operations. .. contents:: On this page :local: diff --git a/source/usage-examples/insertMany.txt b/source/usage-examples/insertMany.txt index c70f23b3..51252382 100644 --- a/source/usage-examples/insertMany.txt +++ b/source/usage-examples/insertMany.txt @@ -10,6 +10,7 @@ Insert Multiple Documents .. meta:: :keywords: code example, .NET, operation + :description: Learn to insert multiple documents into a collection using C# with synchronous and asynchronous methods. .. contents:: On this page :local: diff --git a/source/usage-examples/insertOne.txt b/source/usage-examples/insertOne.txt index 235c8694..3bf2fddc 100644 --- a/source/usage-examples/insertOne.txt +++ b/source/usage-examples/insertOne.txt @@ -10,6 +10,7 @@ Insert a Document .. meta:: :keywords: code example, .NET, operation + :description: Insert a single document into a collection using C# with either the synchronous `InsertOne()` or asynchronous `InsertOneAsync()` method. .. contents:: On this page :local: diff --git a/source/usage-examples/replaceOne.txt b/source/usage-examples/replaceOne.txt index af2259b4..c3832012 100644 --- a/source/usage-examples/replaceOne.txt +++ b/source/usage-examples/replaceOne.txt @@ -10,6 +10,7 @@ Replace a Document .. meta:: :keywords: code example, .NET, operation + :description: Replace a document in a collection using the `ReplaceOne()` or `ReplaceOneAsync()` methods, with examples for both synchronous and asynchronous operations. .. contents:: On this page :local: diff --git a/source/usage-examples/updateMany.txt b/source/usage-examples/updateMany.txt index 745ed606..f8e5f99f 100644 --- a/source/usage-examples/updateMany.txt +++ b/source/usage-examples/updateMany.txt @@ -10,6 +10,7 @@ Update Many Documents .. meta:: :keywords: code example, .NET, operation + :description: Update multiple documents in a collection using the `UpdateMany()` method to change specific field values. .. contents:: On this page :local: diff --git a/source/usage-examples/updateOne.txt b/source/usage-examples/updateOne.txt index cf4188b6..b0d02b43 100644 --- a/source/usage-examples/updateOne.txt +++ b/source/usage-examples/updateOne.txt @@ -10,6 +10,7 @@ Update a Document .. meta:: :keywords: code example, .NET, operation + :description: Learn how to update a single document in a MongoDB collection using the `UpdateOne()` method with C# drivers. .. contents:: On this page :local: diff --git a/source/whats-new.txt b/source/whats-new.txt index 4ac55477..ecd0ca5b 100644 --- a/source/whats-new.txt +++ b/source/whats-new.txt @@ -16,6 +16,7 @@ What's New .. meta:: :keywords: update, new feature, deprecation, upgrade, driver v2.25, driver v2.26, driver v2.27, driver v2.28, driver v3.0 + :description: Discover the latest features and updates in the C# Driver, including new conventions, serializers, and support for various MongoDB functionalities. Learn what's new in: