(DOCSP-19478) Versioned GitHub Links (#220)

Author: biniona-mongodb

snooty.toml

@@ -12,7 +12,9 @@ avro = "Apache Avro"
 avro-short = "Avro"
 kafka-connect = "Confluent Kafka Connect"
 connector_version="1.6"
+connector_minor_version="1"
 connector_driver_version="4.3"
+connector_version_github_tag="r{+connector_version+}.{+connector_minor_version+}"
 sink-connector="MongoDB Kafka sink connector"
 source-connector="MongoDB Kafka source connector"
 connector_driver_url_base="https://docs.mongodb.com/drivers/java/sync/v{+connector_driver_version+}/"

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/master/src/main/java/com/mongodb/kafka/connect/sink/cdc/debezium>`.
+      :github:`the {+mkc+} 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/master/src/main/java/com/mongodb/kafka/connect/sink/cdc/debezium/rdbms/postgres/PostgresHandler.java>`.
+      :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>`.
 
    .. tab::
       :tabid: MySQL
@@ -66,12 +66,12 @@ 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/master/src/main/java/com/mongodb/kafka/connect/sink/cdc/debezium/rdbms/mysql/MysqlHandler.java>`.
+      :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>`.
 
 .. note:: Customize the Debezium CDC Handler
 
    If the Debezium CDC handler is unable to replicate CDC events
    from your datastore, you can customize the handler by extending the 
-   :github:`DebeziumCdcHandler <mongodb/mongo-kafka/blob/master/src/main/java/com/mongodb/kafka/connect/sink/cdc/debezium/DebeziumCdcHandler.java>` 
+   :github:`DebeziumCdcHandler <mongodb/mongo-kafka/blob/{+connector_version_github_tag+}/src/main/java/com/mongodb/kafka/connect/sink/cdc/debezium/DebeziumCdcHandler.java>` 
    class. For more information on custom CDC handlers, see the
    :ref:`Create your Own CDC Handler section <cdc-create-your-own>` of this guide.

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/master/src/main/java/com/mongodb/kafka/connect/sink/cdc/mongodb>`.
+:github:`the {+mkc+} 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,12 +21,12 @@ 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/master/src/main/java/com/mongodb/kafka/connect/sink/cdc/qlik/rdbms/RdbmsHandler.java>`.
+: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>`.
 
 .. note:: Customize the Qlik Replicate CDC Handler
 
    If the Qlik Replicate CDC handler is unable to replicate CDC events
    from your datastore, you can customize the handler by extending the 
-   :github:`QlikCdcHandler <mongodb/mongo-kafka/blob/master/src/main/java/com/mongodb/kafka/connect/sink/cdc/qlik/QlikCdcHandler.java>` 
+   :github:`QlikCdcHandler <mongodb/mongo-kafka/blob/{+connector_version_github_tag+}/src/main/java/com/mongodb/kafka/connect/sink/cdc/qlik/QlikCdcHandler.java>` 
    class. For more information on custom CDC handlers, see the
    :ref:`Create your Own CDC Handler section <cdc-create-your-own>` of this guide.

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

@@ -66,8 +66,8 @@ connector deployment:
   MongoDB Kafka connector, the logic from that class is split into the
   following classes:
 
-  - :github:`MongoSinkConfig <mongodb/mongo-kafka/blob/master/src/main/java/com/mongodb/kafka/connect/sink/MongoSinkConfig.java>`
-  - :github:`MongoSinkTopicConfig <mongodb/mongo-kafka/blob/master/src/main/java/com/mongodb/kafka/connect/sink/MongoSinkTopicConfig.java>`
+  - :github:`MongoSinkConfig <mongodb/mongo-kafka/blob/{+connector_version_github_tag+}/src/main/java/com/mongodb/kafka/connect/sink/MongoSinkConfig.java>`
+  - :github:`MongoSinkTopicConfig <mongodb/mongo-kafka/blob/{+connector_version_github_tag+}/src/main/java/com/mongodb/kafka/connect/sink/MongoSinkTopicConfig.java>`
 
 
 Update Post Processor Subclasses
@@ -76,5 +76,4 @@ Update Post Processor Subclasses
 If you have classes that subclass a post processor in your Kafka Connect
 connector deployment, update methods that override ones in the Kafka Connect
 ``PostProcessor`` class to match the method signatures of the MongoDB Kafka
-connector :github:`PostProcessor class <mongodb/mongo-kafka/blob/master/src/main/java/com/mongodb/kafka/connect/sink/processor/PostProcessor.java>`.
-
+connector :github:`PostProcessor class <mongodb/mongo-kafka/blob/{+connector_version_github_tag+}/src/main/java/com/mongodb/kafka/connect/sink/processor/PostProcessor.java>`.

source/sink-connector/configuration-properties.txt

@@ -20,8 +20,7 @@ including essential {+kafka-connect+} settings and {+mkc+}-specific
 settings.
 
 For an example sink connector configuration file, see
-`MongoSinkConnector.properties
-<https://github.com/mongodb/mongo-kafka/blob/master/config/MongoSinkConnector.properties>`__.
+:github:`MongoSinkConnector.properties <mongodb/mongo-kafka/blob/{+connector_version_github_tag+}/config/MongoSinkConnector.properties>`.
 
 .. _sink-settings:
 

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

@@ -90,10 +90,10 @@ If none of the prebuilt CDC handlers fit your use case, you can create your own.
 Your custom CDC handler is a Java class that implements the ``CdcHandler`` interface.
 
 To learn more, see the
-:github:`source code for the CdcHandler interface <mongodb/mongo-kafka/blob/master/src/main/java/com/mongodb/kafka/connect/sink/cdc/CdcHandler.java>`.
+:github:`source code for the CdcHandler interface <mongodb/mongo-kafka/blob/{+connector_version_github_tag+}/src/main/java/com/mongodb/kafka/connect/sink/cdc/CdcHandler.java>`.
 
 To view examples of CDC handler implementations, see
-:github:`the source code for the prebuilt CDC handlers <mongodb/mongo-kafka/tree/master/src/main/java/com/mongodb/kafka/connect/sink/cdc>`.
+:github:`the source code for the prebuilt CDC handlers <mongodb/mongo-kafka/tree/{+connector_version_github_tag+}/src/main/java/com/mongodb/kafka/connect/sink/cdc>`.
 
 How to Use Your CDC Handler
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~

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

@@ -51,7 +51,7 @@ Post processors perform data modification tasks such as generating
 the document ``_id`` field, projecting message key or value fields, and
 renaming fields. You can use the prebuilt post processors included in the
 connector, or you can implement your own by extending the
-`PostProcessor <https://github.com/mongodb/mongo-kafka/blob/master/src/main/java/com/mongodb/kafka/connect/sink/processor/PostProcessor.java>`_
+:github:`PostProcessor <mongodb/mongo-kafka/blob/{+connector_version_github_tag+}/src/main/java/com/mongodb/kafka/connect/sink/processor/PostProcessor.java>`
 class.
 
 .. _sink-post-processors-specify:
@@ -323,7 +323,8 @@ Create a Custom Document Id Strategy
 If the built-in document id adder strategies do not cover your use case,
 you can define a custom document id strategy by following the steps below:
 
-1. Create a Java class that implements the interface `IdStrategy <https://github.com/mongodb/mongo-kafka/blob/master/src/main/java/com/mongodb/kafka/connect/sink/processor/id/strategy/IdStrategy.java>`__
+1. Create a Java class that implements the interface 
+   :github:`IdStrategy <mongodb/mongo-kafka/blob/{+connector_version_github_tag+}/src/main/java/com/mongodb/kafka/connect/sink/processor/id/strategy/IdStrategy.java>`
    and contains your custom configuration logic.
 
 #. Compile the class to a JAR file.
@@ -343,7 +344,8 @@ you can define a custom document id strategy by following the steps below:
    if you can guarantee the fields that form the document id are unique.
 
 For example implementations of the ``IdStrategy`` interface, see the
-source code directory that contains `id strategy implementations <https://github.com/mongodb/mongo-kafka/tree/master/src/main/java/com/mongodb/kafka/connect/sink/processor/id/strategy>`__
+source code directory that contains 
+:github:`id strategy implementations <mongodb/mongo-kafka/tree/{+connector_version_github_tag+}/src/main/java/com/mongodb/kafka/connect/sink/processor/id/strategy>`
 packaged with the connector.
 
 .. _sink-post-processors-examples:
@@ -852,8 +854,8 @@ How to Create a Custom Post Processor
 If the built-in post processors do not cover your use case, you can create
 a custom post processor class using the following steps:
 
-1. Create a Java class that extends the `PostProcessor
-   <https://github.com/mongodb/mongo-kafka/blob/master/src/main/java/com/mongodb/kafka/connect/sink/processor/PostProcessor.java>`__
+1. Create a Java class that extends the 
+   :github:`PostProcessor <mongodb/mongo-kafka/blob/{+connector_version_github_tag+}/src/main/java/com/mongodb/kafka/connect/sink/processor/PostProcessor.java>`
    abstract class.
 
 #. Override the ``process()`` method in your class. You can update the
@@ -871,5 +873,4 @@ a custom post processor class using the following steps:
    configuration.
 
 For example post processors, you can browse the
-`source code for the built-in post processor classes <https://github.com/mongodb/mongo-kafka/tree/master/src/main/java/com/mongodb/kafka/connect/sink/processor>`__.
-
+:github:`source code for the built-in post processor classes <mongodb/mongo-kafka/tree/{+connector_version_github_tag+}/src/main/java/com/mongodb/kafka/connect/sink/processor>`.

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

@@ -35,7 +35,7 @@ To learn more about bulk writes, see the MongoDB Java driver
 `guide on bulk writes <{+connector_driver_url_base+}fundamentals/crud/write-operations/bulk/>`__.
 
 To learn how write model strategies work in the connector, see 
-:github:`this section of the {+mkc+} source code <mongodb/mongo-kafka/blob/master/src/main/java/com/mongodb/kafka/connect/sink/writemodel/strategy/InsertOneDefaultStrategy.java>`.
+:github:`this section of the {+mkc+} source code <mongodb/mongo-kafka/blob/{+connector_version_github_tag+}/src/main/java/com/mongodb/kafka/connect/sink/writemodel/strategy/InsertOneDefaultStrategy.java>`.
 
 To learn more about strategies, see the 
 `Wikipedia article on the strategy pattern <https://en.wikipedia.org/wiki/Strategy_pattern>`__.
@@ -295,7 +295,7 @@ Your custom write model strategy is a Java class that implements the
 ``WriteModelStrategy`` interface and overrides the ``createWriteModel()`` method.
 
 To learn more, see the
-:github:`source code for the WriteModelStrategy interface <mongodb/mongo-kafka/blob/master/src/main/java/com/mongodb/kafka/connect/sink/writemodel/strategy/WriteModelStrategy.java>`.
+:github:`source code for the WriteModelStrategy interface <mongodb/mongo-kafka/blob/{+connector_version_github_tag+}/src/main/java/com/mongodb/kafka/connect/sink/writemodel/strategy/WriteModelStrategy.java>`.
 
 Sample Write Model Strategy
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~

source/source-connector/configuration-properties.txt

@@ -20,7 +20,7 @@ including essential {+kafka-connect+} settings and {+mkc+}-specific
 settings.
 
 For an example source connector configuration file, see
-`MongoSourceConnector.properties <https://github.com/mongodb/mongo-kafka/blob/master/config/MongoSourceConnector.properties>`__.
+:github:`MongoSourceConnector.properties <mongodb/mongo-kafka/blob/{+connector_version_github_tag+}/config/MongoSourceConnector.properties>`.
 
 Settings
 --------