DOCSP-19316: change source constants to be more readable (#62)

* DOCSP-19316: change source constants to be more readable

* name changes

* CC renaming suggestions

* use source constants on high traffic pgs

* merge conflicts left an old constant behind-- fixed

* change constants to short

Author: rustagir

snooty.toml

@@ -4,13 +4,13 @@ intersphinx = ["https://www.mongodb.com/docs/manual/objects.inv"]
 toc_landing_pages = ["/introduction", "/tutorials", "/sink-connector", "/source-connector", "/sink-connector/configuration-properties", "/source-connector/configuration-properties", "/sink-connector/fundamentals", "/source-connector/fundamentals", "/source-connector/usage-examples", "/security-and-authentication", "/troubleshooting"]
 
 [constants]
-mkc = "MongoDB Kafka Connector"
+connector = "MongoDB Kafka Connector"
 connector-long = "MongoDB Connector for Apache Kafka"
-ak = "Apache Kafka"
-kc = "Kafka Connect"
-avro = "Apache Avro"
-avro-short = "Avro"
-kafka-connect = "Confluent Kafka Connect"
+kafka = "Apache Kafka"
+kafka-connect = "Kafka Connect"
+kafka-connect-long = "Confluent Kafka Connect"
+avro-long = "Apache Avro"
+avro = "Avro"
 connector_version="1.8"
 connector_patch_version="1"
 connector_driver_version="4.5"

source/compatibility.txt

@@ -26,27 +26,27 @@ MongoDB v4.0 or later.
 
 .. note::
 
-   We recommend that you only use the {+mkc+} with an official version
+   We recommend that you only use the {+connector+} with an official version
    of the MongoDB server. We cannot guarantee it functions correctly
    with any other version.
 
 Kafka Compatibility
 -------------------
 
-The {+mkc+} requires Kafka Connect v2.1.0 or later. It's
-tested against Apache Kafka v2.3 and later. You can use the Kafka
-Connect service with several Apache Kafka compatible platforms including
-the following:
+The {+connector+} requires {+kafka-connect-long+} v2.1.0 or later. It's
+tested against {+kafka+} v2.3 and later. You can use the
+{+kafka-connect+} service with several {+kafka+} compatible platforms
+including the following:
 
 - Confluent Platform v5.3 or later
 - Microsoft Azure Event Hubs
 - Red Hat AMQ Streams
 
-The {+mkc+} works directly with {+kafka-connect+}. The connector does not
+The connector works directly with {+kafka-connect+}. The connector does not
 connect directly to a Kafka cluster which means it's compatible with any
-Apache Kafka platform that supports {+kafka-connect+}.
+{+kafka+} platform that supports {+kafka-connect+}.
 
-If you have any questions about the {+mkc+}, ask them on the 
+If you have any questions about the connector, ask them on the 
 `MongoDB Community Forums
 <https://www.mongodb.com/community/forums/c/data/connectors-integrations/>`__.
 

source/contribute.txt

@@ -2,7 +2,7 @@
 How to Contribute
 =================
 
-We are happy to accept contributions to help improve the {+mkc+}. We guide
+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:
 
@@ -39,7 +39,7 @@ Gradle checks. You can run the checks with the following command:
 .. note:: Skipped Tests
 
    You can skip tests in the ``integrationTest`` task related to 
-   the following areas unless your code specifically modifies {+mkc+} behavior
+   the following areas unless your code specifically modifies {+connector+} behavior
    related to these areas:
 
    - Specific versions of MongoDB
@@ -54,7 +54,7 @@ Gradle checks. You can run the checks with the following command:
    You can run tests related to a specific MongoDB version by deploying a local replica set
    with that version of MongoDB.
 
-To learn more about the {+mkc+} source code, see the :github:`GitHub repository <mongodb/mongo-kafka>`.
+To learn more about the {+connector+} source code, see the :github:`GitHub repository <mongodb/mongo-kafka>`.
 
 To learn more about Gradle, see the official
 `Gradle website <https://docs.gradle.org/>`__.

source/includes/fundamentals/cdc/debezium.rst

@@ -28,7 +28,7 @@ CDC events from each of the preceding datastores:
          change.data.capture.handler=com.mongodb.kafka.connect.sink.cdc.debezium.mongodb.MongoDbHandler
 
       To view the source code for the Debezium CDC handler, see
-      :github:`the {+mkc+} source code </mongodb/mongo-kafka/tree/{+connector_version_github_tag+}/src/main/java/com/mongodb/kafka/connect/sink/cdc/debezium>`.
+      :github:`the {+connector+} source code </mongodb/mongo-kafka/tree/{+connector_version_github_tag+}/src/main/java/com/mongodb/kafka/connect/sink/cdc/debezium>`.
 
    .. tab::
       :tabid: Postgres
@@ -47,7 +47,7 @@ CDC events from each of the preceding datastores:
          change.data.capture.handler=com.mongodb.kafka.connect.sink.cdc.debezium.rdbms.postgres.PostgresHandler
 
       To view the source code for the Debezium CDC handler, see
-      :github:`the {+mkc+} source code <mongodb/mongo-kafka/blob/{+connector_version_github_tag+}/src/main/java/com/mongodb/kafka/connect/sink/cdc/debezium/rdbms/postgres/PostgresHandler.java>`.
+      :github:`the {+connector+} source code <mongodb/mongo-kafka/blob/{+connector_version_github_tag+}/src/main/java/com/mongodb/kafka/connect/sink/cdc/debezium/rdbms/postgres/PostgresHandler.java>`.
 
    .. tab::
       :tabid: MySQL
@@ -66,7 +66,7 @@ CDC events from each of the preceding datastores:
          change.data.capture.handler=com.mongodb.kafka.connect.sink.cdc.debezium.rdbms.mysql.MysqlHandler
 
       To view the source code for the Debezium CDC handler, see
-      :github:`the {+mkc+} source code <mongodb/mongo-kafka/blob/{+connector_version_github_tag+}/src/main/java/com/mongodb/kafka/connect/sink/cdc/debezium/rdbms/mysql/MysqlHandler.java>`.
+      :github:`the {+connector+} source code <mongodb/mongo-kafka/blob/{+connector_version_github_tag+}/src/main/java/com/mongodb/kafka/connect/sink/cdc/debezium/rdbms/mysql/MysqlHandler.java>`.
 
 .. note:: Customize the Debezium CDC Handler
 

source/includes/fundamentals/cdc/mongodb.rst

@@ -14,4 +14,4 @@ MongoDB change event documents:
    change.data.capture.handler=com.mongodb.kafka.connect.sink.cdc.mongodb.ChangeStreamHandler
 
 To view the source code for the MongoDB CDC handler, see
-:github:`the {+mkc+} source code <mongodb/mongo-kafka/tree/{+connector_version_github_tag+}/src/main/java/com/mongodb/kafka/connect/sink/cdc/mongodb>`.
+:github:`the {+connector+} source code <mongodb/mongo-kafka/tree/{+connector_version_github_tag+}/src/main/java/com/mongodb/kafka/connect/sink/cdc/mongodb>`.

source/includes/fundamentals/cdc/qlik.rst

@@ -21,7 +21,7 @@ Qlik Replicate CDC events:
    change.data.capture.handler=com.mongodb.kafka.connect.sink.cdc.qlik.rdbms.RdbmsHandler
 
 To view the source code for the Qlik Replicate CDC handler, see
-:github:`the {+mkc+} source code </mongodb/mongo-kafka/tree/{+connector_version_github_tag+}/src/main/java/com/mongodb/kafka/connect/sink/cdc/qlik/rdbms/RdbmsHandler.java>`.
+:github:`the {+connector+} source code </mongodb/mongo-kafka/tree/{+connector_version_github_tag+}/src/main/java/com/mongodb/kafka/connect/sink/cdc/qlik/rdbms/RdbmsHandler.java>`.
 
 .. note:: Customize the Qlik Replicate CDC Handler
 

source/includes/schema-converter-important.rst

@@ -1,5 +1,5 @@
 .. important:: Converters
 
-   If you want to send your data through {+ak+} with {+avro-short+} binary encoding,
-   you must use an {+avro-short+} converter. For more information, see the guide on
+   If you want to send your data through {+kafka+} with {+avro+} binary encoding,
+   you must use an {+avro+} converter. For more information, see the guide on
    :ref:`Converters <intro-converters>`.

source/includes/source-connector-change-stream.rst

@@ -1,4 +1,4 @@
 A {+source-connector+} works by opening a single change stream with
-MongoDB and sending data from that change stream to {+kc+}. Your source
+MongoDB and sending data from that change stream to {+kafka-connect+}. Your source
 connector maintains its change stream for the duration of its runtime, and your
 connector closes its change stream when you stop it.

source/includes/steps-cdc-tutorial.yaml

@@ -268,7 +268,7 @@ content: |
     to a topic rather than stop. To learn how to write errant messages to a topic,
     see :ref:`<kafka-sink-errors-dlq>`.
   - Remove the ``change.data.capture.handler`` from your sink connector.
-    Add the :ref:`source connector from the tutorial <cdc-tutorial-source-connector>` to {+kc+}
+    Add the :ref:`source connector from the tutorial <cdc-tutorial-source-connector>` to {+kafka-connect+}
     if its not already added. Insert a document into MongoDB
     :ref:`as done in the tutorial <cdc-tutorial-change-data-insert>`.
     Look at the :ref:`change event document <source-connector-fundamentals-change-event>`

source/includes/tutorials/feedback.rst

@@ -3,5 +3,5 @@
 
 .. note::
 
-   Send your tutorial feedback or ideas for future {+mkc+} tutorials through
+   Send your tutorial feedback or ideas for future {+connector+} tutorials through
    this `feedback form <https://tinyurl.com/mongokafkatutorialfeedback>`__.