(DOCSP-19733) All Properties Pages (#219)

Author: biniona-mongodb

source/sink-connector/configuration-properties.txt

@@ -71,6 +71,9 @@ See the following categories for a list of related configuration properties:
      - Configure the connector to sink data to a MongoDB time series
        collection.
 
+   * - :doc:`All Properties </sink-connector/configuration-properties/all-properties>`
+     - View all preceding categories of configuration properties on one page.
+
 See the `Confluent Sink Connector documentation <https://docs.confluent.io/current/installation/configuration/connect/sink-connect-configs.html>`__
 for more information on these settings.
 
@@ -88,4 +91,4 @@ for more information on these settings.
    Topic Override <sink-connector/configuration-properties/topic-override>
    Change Data Capture <sink-connector/configuration-properties/cdc>
    Time Series <sink-connector/configuration-properties/time-series>
-
+   All Properties <sink-connector/configuration-properties/all-properties>

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

@@ -0,0 +1,178 @@
+.. _sink-configuration-all-properties:
+
+===========================================
+All Sink Connector Configuration Properties
+===========================================
+
+.. default-domain:: mongodb
+
+.. contents:: On this page
+   :local:
+   :backlinks: none
+   :depth: 2
+   :class: singlecol
+
+Overview
+--------
+
+On this page, you can view all available configuration properties
+for your {+sink-connector+}. This page duplicates the content of the
+other sink connector configuration properties pages. 
+
+To view a list of all sink connector configuration properties pages,
+see the :ref:`<kafka-sink-configuration-properties>` page.
+
+MongoDB Connection
+------------------
+
+.. include:: /sink-connector/configuration-properties/mongodb-connection.txt
+   :start-after: sink-configuration-mongodb-connection-description-start
+   :end-before: sink-configuration-mongodb-connection-description-end
+
+To view only the options related to configuring your MongoDB connection,
+see the :ref:`<sink-configuration-mongodb-connection>` page.
+
+.. include:: /sink-connector/configuration-properties/mongodb-connection.txt
+   :start-after: sink-configuration-mongodb-connection-table-start
+   :end-before: sink-configuration-mongodb-connection-table-end
+
+MongoDB Namespace
+-----------------
+
+.. include:: /sink-connector/configuration-properties/mongodb-namespace.txt
+   :start-after: sink-configuration-namespace-mapping-description-start
+   :end-before: sink-configuration-namespace-mapping-description-end
+
+To view only the options related to specifying where the connector writes data,
+see the :ref:`<sink-configuration-namespace-mapping>` page.
+
+.. include:: /sink-connector/configuration-properties/mongodb-namespace.txt
+   :start-after: sink-configuration-namespace-mapping-table-start
+   :end-before: sink-configuration-namespace-mapping-table-end
+
+Connector Topic
+---------------
+
+.. include:: /sink-connector/configuration-properties/kafka-topic.txt
+   :start-after: sink-configuration-topic-properties-description-start
+   :end-before: sink-configuration-topic-properties-description-end
+
+To view only the options related to specifying Kafka topics, see the
+:ref:`<sink-configuration-topic-properties>` page.
+
+.. include:: /sink-connector/configuration-properties/kafka-topic.txt
+   :start-after: sink-configuration-topic-properties-table-start
+   :end-before: sink-configuration-topic-properties-table-end
+
+Connector Message Processing
+----------------------------
+
+.. include:: /sink-connector/configuration-properties/connector-message.txt
+   :start-after: sink-configuration-message-processing-description-start
+   :end-before: sink-configuration-message-processing-description-end
+
+To view only the options related to change data capture handlers, see the
+:ref:`<sink-configuration-message-processing>` page.
+
+.. include:: /sink-connector/configuration-properties/connector-message.txt
+   :start-after: sink-configuration-message-processing-table-start
+   :end-before: sink-configuration-message-processing-table-end
+
+Connector Error Handling
+------------------------
+
+.. include:: /sink-connector/configuration-properties/error-handling.txt
+   :start-after: sink-configuration-error-handling-description-start
+   :end-before: sink-configuration-error-handling-description-end
+
+To view only the options related to handling errors, see the
+:ref:`<sink-configuration-error-handling>` page.
+
+.. include:: /sink-connector/configuration-properties/error-handling.txt
+   :start-after: sink-configuration-error-handling-table-start
+   :end-before: sink-configuration-error-handling-table-end
+
+Post Processors
+---------------
+
+.. include:: /sink-connector/configuration-properties/post-processors.txt
+   :start-after: sink-configuration-post-processors-description-start
+   :end-before: sink-configuration-post-processors-description-end
+
+To view only the options related to post-processors, see the
+:ref:`<sink-configuration-post-processors>` page.
+
+.. include:: /sink-connector/configuration-properties/post-processors.txt
+   :start-after: sink-configuration-post-processors-table-start
+   :end-before: sink-configuration-post-processors-table-end
+
+ID Strategy
+-----------
+
+.. include:: /sink-connector/configuration-properties/id-strategy.txt
+   :start-after: sink-configuration-id-strategy-description-start
+   :end-before: sink-configuration-id-strategy-description-end
+
+To view only the options related to determining the ``_id`` field of your
+documents, see the :ref:`<sink-configuration-id-strategy>` page.
+
+.. include:: /sink-connector/configuration-properties/id-strategy.txt
+   :start-after: sink-configuration-id-strategy-table-start
+   :end-before: sink-configuration-id-strategy-table-end
+
+Write Model Strategy
+--------------------
+
+.. include:: /sink-connector/configuration-properties/write-strategies.txt
+   :start-after: sink-configuration-write-model-strategy-description-start
+   :end-before: sink-configuration-write-model-strategy-description-end
+
+To view only the options related to write model strategies, see the
+:ref:`<sink-configuration-write-model-strategy>` page.
+
+.. include:: /sink-connector/configuration-properties/write-strategies.txt
+   :start-after: sink-configuration-write-model-strategy-table-start
+   :end-before: sink-configuration-write-model-strategy-table-end
+
+Topic Override
+--------------
+
+.. include:: /sink-connector/configuration-properties/topic-override.txt
+   :start-after: sink-configuration-topic-override-description-start
+   :end-before: sink-configuration-topic-override-description-end
+
+To view only the options related to overriding topic settings, see the
+:ref:`<sink-configuration-topic-override>` page.
+
+.. include:: /sink-connector/configuration-properties/topic-override.txt
+   :start-after: sink-configuration-topic-override-table-start
+   :end-before: sink-configuration-topic-override-table-end
+
+Change Data Capture
+-------------------
+
+.. include:: /sink-connector/configuration-properties/cdc.txt
+   :start-after: sink-configuration-change-data-capture-description-start
+   :end-before: sink-configuration-change-data-capture-description-end
+
+To view only the options related to change data capture handlers, see the
+:ref:`<sink-configuration-change-data-capture>` page.
+
+.. include:: /sink-connector/configuration-properties/cdc.txt
+   :start-after: sink-configuration-change-data-capture-table-start
+   :end-before: sink-configuration-change-data-capture-table-end
+
+Time Series
+-----------
+
+.. include:: /sink-connector/configuration-properties/time-series.txt
+   :start-after: sink-configuration-time-series-description-start
+   :end-before: sink-configuration-time-series-description-end
+
+To view only the options related to time series collections, see the
+:ref:`<sink-configuration-time-series>` page.
+
+.. include:: /sink-connector/configuration-properties/time-series.txt
+   :start-after: sink-configuration-time-series-table-start
+   :end-before: sink-configuration-time-series-table-end
+

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

@@ -15,18 +15,24 @@ Change Data Capture Properties
 Overview
 --------
 
+.. _sink-configuration-change-data-capture-description-start:
+
 Use the following configuration settings to specify a class the sink
 connector uses to process change data capture (CDC) events.
 
 See the guide on :doc:`Sink Connector Change Data Capture </sink-connector/fundamentals/change-data-capture>`
 for examples using the built-in ``ChangeStreamHandler`` and Debezium event
 producers.
 
+.. _sink-configuration-change-data-capture-description-end:
+
 .. include:: /includes/sink-config-link.rst
 
 Settings
 --------
 
+.. _sink-configuration-change-data-capture-table-start:
+
 .. list-table::
    :header-rows: 1
    :widths: 25 75
@@ -45,3 +51,4 @@ Settings
        | **Accepted Values**: An empty string or a fully qualified Java
          class name
 
+.. _sink-configuration-change-data-capture-table-end:

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

@@ -1,3 +1,5 @@
+.. _sink-configuration-message-processing:
+
 =======================================
 Connector Message Processing Properties
 =======================================
@@ -13,18 +15,24 @@ Connector Message Processing Properties
 Overview
 --------
 
+.. _sink-configuration-message-processing-description-start:
+
 Use the settings on this page to configure the message processing behavior of
 the sink connector including the following:
 
 - Message batch size
 - Rate limits
 - Number of parallel tasks
 
+.. _sink-configuration-message-processing-description-end:
+
 .. include:: /includes/sink-config-link.rst
 
 Settings
 --------
 
+.. _sink-configuration-message-processing-table-start:
+
 .. list-table::
    :header-rows: 1
    :widths: 25 75
@@ -101,3 +109,4 @@ Settings
        | **Default**: ``1``
        | **Accepted Values**: An integer.
 
+.. _sink-configuration-message-processing-table-end:

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

@@ -15,14 +15,20 @@ Connector Error Handling Properties
 Overview
 --------
 
+.. _sink-configuration-error-handling-description-start:
+
 Use the following configuration settings to specify how the sink connector
 handles errors and to configure the dead letter queue.
 
+.. _sink-configuration-error-handling-description-end:
+
 .. include:: /includes/sink-config-link.rst
 
 Settings
 --------
 
+.. _sink-configuration-error-handling-table-start:
+
 .. list-table::
    :header-rows: 1
    :widths: 50 50
@@ -118,6 +124,7 @@ Settings
        | **Default:** ``3``
        | **Accepted Values**: A valid number of nodes
 
+.. _sink-configuration-error-handling-table-end:
 
 .. _sink-dead-letter-queue-configuration-example:
 

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

@@ -1,3 +1,5 @@
+.. _sink-configuration-id-strategy:
+
 =====================================
 Sink Connector Id Strategy Properties
 =====================================
@@ -13,14 +15,20 @@ Sink Connector Id Strategy Properties
 Overview
 --------
 
+.. _sink-configuration-id-strategy-description-start:
+
 Use the following configuration settings to specify how the sink connector
 should determine the ``_id`` value for each document it writes to MongoDB.
 
+.. _sink-configuration-id-strategy-description-end:
+
 .. include:: /includes/sink-config-link.rst
 
 Settings
 --------
 
+.. _sink-configuration-id-strategy-table-start:
+
 .. list-table::
    :header-rows: 1
    :widths: 45 55
@@ -78,3 +86,4 @@ Settings
        | **Default**: ``false``
        | **Accepted Values**: ``true`` or ``false``
 
+.. _sink-configuration-id-strategy-table-end:

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

@@ -15,14 +15,20 @@ Kafka Topic Properties
 Overview
 --------
 
+.. _sink-configuration-topic-properties-description-start:
+
 Use the following configuration settings to specify which Kafka topics the
 sink connector should watch for data.
 
+.. _sink-configuration-topic-properties-description-end:
+
 .. include:: /includes/sink-config-link.rst
 
 Settings
 --------
 
+.. _sink-configuration-topic-properties-table-start:
+
 .. list-table::
    :header-rows: 1
    :widths: 25 75
@@ -71,3 +77,4 @@ Settings
 
        | **Accepted Values**: A valid regular expression pattern using ``java.util.regex.Pattern``.
 
+.. _sink-configuration-topic-properties-table-end:

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

@@ -1,3 +1,5 @@
+.. _sink-configuration-mongodb-connection:
+
 ===========================================
 MongoDB Connection Configuration Properties
 ===========================================
@@ -13,14 +15,20 @@ MongoDB Connection Configuration Properties
 Overview
 --------
 
+.. _sink-configuration-mongodb-connection-description-start:
+
 Use the following configuration settings to specify how your sink
 connector connects and communicates with your MongoDB cluster.
 
+.. _sink-configuration-mongodb-connection-description-end:
+
 .. include:: /includes/sink-config-link.rst
 
 Settings
 --------
 
+.. _sink-configuration-mongodb-connection-table-start:
+
 .. list-table::
    :header-rows: 1
    :widths: 30 70
@@ -103,3 +111,4 @@ Settings
        | **Default**: ``false``
        | **Accepted Values**: ``true`` or ``false``
 
+.. _sink-configuration-mongodb-connection-table-end: