Merge pull request #201 from mongodb/missing-meta-descriptions

Add missing meta descriptions

Author: jwilliams-mongo

source/compatibility.txt

@@ -10,6 +10,7 @@ Compatibility
 
 .. meta:: 
    :keywords: version, backwards, conflict, platforms
+   :description: Ensure compatibility of the Kafka Connector with MongoDB and Confluent Kafka Connect, supporting various Apache Kafka platforms.
 
 MongoDB Compatibility
 ---------------------

source/contribute.txt

@@ -4,6 +4,9 @@
 How to Contribute
 =================
 
+.. meta::
+   :description: Contribute to the Kafka Connector by following guidelines for code standards, documentation, and testing, ensuring your pull request passes all Gradle checks.
+
 We are happy to accept contributions to help improve the {+connector+}. We guide
 community contributions to ensure they meet the standards of the codebase. Please
 ensure that your pull request meets the following criteria:

source/index.txt

@@ -5,6 +5,9 @@
 MongoDB Kafka Connector
 =======================
 
+.. meta::
+   :description: Explore how to use the MongoDB Kafka Connector to integrate data between Apache Kafka and MongoDB, including setup, configuration, and security.
+
 .. toctree::
    :titlesonly:
    :maxdepth: 1

source/introduction.txt

@@ -4,6 +4,9 @@
 Introduction
 ============
 
+.. meta::
+   :description: Explore sections on the MongoDB Kafka Connector, including installation, connection, data formats, and converters.
+
 .. toctree::
    :titlesonly:
 

source/introduction/connect.txt

@@ -4,6 +4,9 @@
 Connect to MongoDB
 ==================
 
+.. meta::
+   :description: Connect the MongoDB Kafka Connector to MongoDB using a connection URI, specifying address, settings, and authentication options.
+
 .. contents:: On this page
    :local:
    :backlinks: none

source/introduction/converters.txt

@@ -4,6 +4,9 @@
 Converters
 ==========
 
+.. meta::
+   :description: Explore how to use converters with the Kafka Connector to translate data between MongoDB and Kafka Connect, including configuration templates for various converters.
+
 .. contents:: On this page
    :local:
    :backlinks: none

source/introduction/data-formats.txt

@@ -4,6 +4,9 @@
 Data Formats
 ============
 
+.. meta::
+   :description: Explore various data formats like JSON, BSON, Avro, and byte arrays used with the MongoDB Kafka Connector, including their applications and specifications.
+
 .. contents:: On this page
    :local:
    :backlinks: none

source/introduction/install.txt

@@ -4,6 +4,9 @@
 Install the MongoDB Kafka Connector
 ===================================
 
+.. meta::
+   :description: Install the MongoDB Kafka Connector on Confluent Platform or Apache Kafka by downloading the appropriate JAR files and following specific setup instructions.
+
 .. contents:: On this page
    :local:
    :backlinks: none
@@ -123,4 +126,3 @@ file name. Consult the following table for a description of each suffix:
 For example,
 ``mongo-kafka-connect-{+connector_version+}.{+connector_patch_version+}-all.jar``
 is the uber JAR for the version {+connector_version+}.{+connector_patch_version+} connector.
-

source/introduction/kafka-connect.txt

@@ -4,6 +4,9 @@
 Kafka and Kafka Connect
 =======================
 
+.. meta::
+   :description: Learn about Apache Kafka and Kafka Connect, their benefits, and how they facilitate data movement between datastores like MongoDB.
+
 .. contents:: On this page
    :local:
    :backlinks: none

source/issues-and-help.txt

@@ -4,6 +4,9 @@
 Issues & Help
 =============
 
+.. meta::
+   :description: Find support for the Kafka Connector through community forums, report bugs, or request features via JIRA.
+
 Often, the quickest way to get support for general questions is through the
 `MongoDB Community Forums <https://www.mongodb.com/community/forums/tags/c/connectors-integrations/48/kafka-connector>`__.
 

source/migrate-from-kafka-connect-mongodb.txt

@@ -4,6 +4,9 @@
 Migrate from Kafka Connect MongoDB
 ==================================
 
+.. meta::
+   :description: Migrate your Kafka deployments from the community-created Kafka Connect MongoDB sink connector to the official MongoDB Kafka Connector by updating configuration settings and custom classes.
+
 Use this guide to migrate your Kafka deployments from the community-created
 :github:`Kafka Connect MongoDB <hpgrahsl/kafka-connect-mongodb>` sink connector
 to the :github:`official MongoDB Kafka connector <mongodb/mongo-kafka>`.

source/monitoring.txt

@@ -10,6 +10,7 @@ Monitoring
 
 .. meta:: 
    :keywords: logging, audit, metrics
+   :description: Monitor MongoDB Kafka Connectors using JMX to track metrics for source and sink tasks, ensuring optimal performance and identifying potential issues.
 
 .. contents:: On this page
    :local:

source/quick-start.txt

@@ -16,6 +16,7 @@
 
 .. meta::
    :keywords: get started, tutorial, code example
+   :description: Configure the MongoDB Kafka Connector to transfer data between MongoDB and Apache Kafka using a sandbox environment.
 
 .. include:: /includes/atlas-sp.rst
 

source/security-and-authentication.txt

@@ -4,6 +4,9 @@
 Security and Authentication
 ===========================
 
+.. meta::
+   :description: Secure communications between MongoDB and the Kafka Connector by encrypting messages, authenticating with AWS, or implementing a custom authentication provider.
+
 .. toctree::
    :titlesonly:
    :maxdepth: 1

source/security-and-authentication/custom-auth.txt

@@ -10,6 +10,7 @@ Custom Authentication Provider
 
 .. meta::
    :keywords: credentials, implementation class, custom class
+   :description: Implement a custom authentication provider for Kafka Connect by creating a class that adheres to the `CustomCredentialProvider` interface and configure it for AWS IAM.
 
 .. contents:: On this page
    :local:

source/security-and-authentication/mongodb-aws-auth.txt

@@ -10,6 +10,7 @@ MongoDB AWS-based Authentication
 
 .. meta:: 
    :keywords: AWS, IAM, credentials
+   :description: Authenticate the MongoDB Kafka Connector with a MongoDB replica set using AWS IAM credentials via the `MONGODB-AWS` mechanism.
 
 .. contents:: On this page
    :local:

source/security-and-authentication/tls-and-x509.txt

@@ -4,6 +4,9 @@
 SSL/TLS and X.509 Certificates
 ==============================
 
+.. meta::
+   :description: Learn how to secure communications between your Kafka Connector worker and MongoDB cluster using SSL/TLS and X.509 certificates.
+
 .. contents:: On this page
    :local:
    :backlinks: none

source/sink-connector.txt

@@ -4,6 +4,9 @@
 Sink Connector
 ==============
 
+.. meta::
+   :description: Explore how the Kafka sink connector reads data from Apache Kafka and writes it to MongoDB.
+
 .. toctree::
    :titlesonly:
    :maxdepth: 1

source/sink-connector/configuration-properties.txt

@@ -4,6 +4,9 @@
 Sink Connector Configuration Properties
 =======================================
 
+.. meta::
+   :description: Explore the configuration properties for the Kafka sink connector, including MongoDB connection settings, error handling, and data transformation options.
+
 .. contents:: On this page
    :local:
    :backlinks: none

source/sink-connector/configuration-properties/all-properties.txt

@@ -4,6 +4,9 @@
 All Sink Connector Configuration Properties
 ===========================================
 
+.. meta::
+   :description: Explore all configuration properties for the MongoDB Kafka sink connector, including connection settings, namespace mapping, message processing, and error handling.
+
 .. contents:: On this page
    :local:
    :backlinks: none

source/sink-connector/configuration-properties/cdc.txt

@@ -4,6 +4,9 @@
 Change Data Capture Properties
 ==============================
 
+.. meta::
+   :description: Configure the MongoDB Kafka sink connector to process change data capture events using specified CDC handlers.
+
 .. contents:: On this page
    :local:
    :backlinks: none

source/sink-connector/configuration-properties/connector-message.txt

@@ -4,6 +4,9 @@
 Connector Message Processing Properties
 =======================================
 
+.. meta::
+   :description: Configure the message processing behavior of the Kafka sink connector with settings for batch size, rate limits, and parallel tasks.
+
 .. contents:: On this page
    :local:
    :backlinks: none

source/sink-connector/configuration-properties/error-handling.txt

@@ -16,6 +16,7 @@ Connector Error Handling Properties
 
 .. meta::
    :keywords: errors, options, configure
+   :description: Configure error handling and dead letter queue settings for the Kafka sink connector, including error tolerance, logging, and bulk write exception reporting.
 
 Overview
 --------

source/sink-connector/configuration-properties/id-strategy.txt

@@ -4,6 +4,9 @@
 Sink Connector Id Strategy Properties
 =====================================
 
+.. meta::
+   :description: Configure how the Kafka sink connector determines the `_id` value for documents in MongoDB, including strategies for overwriting and UUID formatting.
+
 .. contents:: On this page
    :local:
    :backlinks: none

source/sink-connector/configuration-properties/kafka-topic.txt

@@ -4,6 +4,9 @@
 Kafka Topic Properties for the Sink Connector
 ==============================================
 
+.. meta::
+   :description: Configure which Kafka topics the MongoDB Kafka sink connector should monitor using the `topics` or `topics.regex` settings.
+
 .. contents:: On this page
    :local:
    :backlinks: none

source/sink-connector/configuration-properties/mongodb-connection.txt

@@ -4,6 +4,9 @@
 MongoDB Connection Configuration Properties
 ===========================================
 
+.. meta::
+   :description: Configure how your Kafka sink connector connects to a MongoDB cluster using connection URI, API version, and error handling settings.
+
 .. contents:: On this page
    :local:
    :backlinks: none

source/sink-connector/configuration-properties/mongodb-namespace.txt

@@ -4,6 +4,9 @@
 MongoDB Namespace Mapping Configuration Properties
 ==================================================
 
+.. meta::
+   :description: Configure MongoDB Kafka sink connector to specify target database and collection using default or custom namespace mapping classes.
+
 .. contents:: On this page
    :local:
    :backlinks: none

source/sink-connector/configuration-properties/post-processors.txt

@@ -4,6 +4,9 @@
 Sink Connector Post-processor Properties
 ========================================
 
+.. meta::
+   :description: Configure how the Kafka sink connector transforms data before inserting it into MongoDB using post-processor properties.
+
 .. contents:: On this page
    :local:
    :backlinks: none

source/sink-connector/configuration-properties/time-series.txt

@@ -4,6 +4,9 @@
 Kafka Time Series Properties
 ============================
 
+.. meta::
+   :description: Configure the MongoDB Kafka sink connector to manage data in a time series collection using specific settings for time fields, metadata, and data expiration.
+
 .. facet::
    :name: genre
    :values: reference

source/sink-connector/configuration-properties/topic-override.txt

@@ -4,6 +4,9 @@
 Topic Override Properties
 =========================
 
+.. meta::
+   :description: Override global or default property settings for specific topics in the Kafka sink connector using topic override properties.
+
 .. contents:: On this page
    :local:
    :backlinks: none

source/sink-connector/configuration-properties/write-strategies.txt

@@ -4,6 +4,9 @@
 Sink Connector Write Model Strategies
 =====================================
 
+.. meta::
+   :description: Configure how the Kafka sink connector writes data to MongoDB by setting write model strategies for handling sink records and tombstone events.
+
 .. contents:: On this page
    :local:
    :backlinks: none

source/sink-connector/fundamentals.txt

@@ -4,6 +4,9 @@
 Sink Connector Fundamentals
 ===========================
 
+.. meta::
+   :description: Explore how to configure the MongoDB Kafka sink connector, including data writing, record modification, error handling, and converting change data capture events.
+
 .. toctree::
    :titlesonly:
    :maxdepth: 1

source/sink-connector/fundamentals/change-data-capture.txt

@@ -4,6 +4,9 @@
 Change Data Capture Handlers
 ============================
 
+.. meta::
+   :description: Replicate change data capture events using a MongoDB Kafka sink connector by configuring CDC handlers for various event producers like MongoDB, Debezium, and Qlik Replicate.
+
 .. contents:: On this page
    :local:
    :backlinks: none

source/sink-connector/fundamentals/error-handling-strategies.txt

@@ -16,6 +16,7 @@ Error Handling
 
 .. meta::
    :keywords: sink, processing
+   :description: Learn how to handle errors in your Kafka sink connector with strategies like stopping, tolerating, or logging errors, and using dead letter queues.
 
 Overview
 --------

source/sink-connector/fundamentals/post-processors.txt

@@ -4,6 +4,9 @@
 Sink Connector Post Processors
 ==============================
 
+.. meta::
+   :description: Learn how to configure and use post processors in the Kafka sink connector to modify data before storing it in MongoDB, including creating custom processors.
+
 .. contents:: On this page
    :local:
    :backlinks: none

source/sink-connector/fundamentals/write-strategies.txt

@@ -4,6 +4,9 @@
 Write Model Strategies
 ======================
 
+.. meta::
+   :description: Configure the MongoDB Kafka sink connector write strategies to insert, update, replace, or delete documents using bulk operations and custom strategies.
+
 .. contents:: On this page
    :local:
    :backlinks: none

source/source-connector.txt

@@ -4,6 +4,9 @@
 Source Connector
 ================
 
+.. meta::
+   :description: Explore how the MongoDB Kafka source connector reads data from MongoDB and writes it to Apache Kafka using a change stream.
+
 .. toctree::
    :titlesonly:
    :maxdepth: 1

source/source-connector/configuration-properties.txt

@@ -4,6 +4,9 @@
 Source Connector Configuration Properties
 =========================================
 
+.. meta::
+   :description: Explore MongoDB Kafka source connector properties, including connection, topic, change stream, output format, startup, and error handling settings.
+
 .. contents:: On this page
    :local:
    :backlinks: none

source/source-connector/configuration-properties/all-properties.txt

@@ -4,6 +4,9 @@
 All Source Connector Configuration Properties
 =============================================
 
+.. meta::
+   :description: Explore all configuration properties for the MongoDB Kafka source connector, including connection settings, Kafka topic specifications, change stream options, output formats, startup configurations, and error handling.
+
 .. contents:: On this page
    :local:
    :backlinks: none

source/source-connector/configuration-properties/change-stream.txt

@@ -4,6 +4,9 @@
 Change Stream Properties
 ========================
 
+.. meta::
+   :description: Configure change stream properties for the MongoDB Kafka source connector, including aggregation pipelines, read preferences, and document handling options.
+
 .. contents:: On this page
    :local:
    :backlinks: none