DOCSP-25232 tutorial setup step (#25)

* DOCSP-25232: explicit step for tutorial setup

Author: Chris Cho

snooty.toml

@@ -20,6 +20,8 @@ connector_kafka_version_minor="6"
 connector_kafka_version_docs="https://kafka.apache.org/{+connector_kafka_version_major+}{+connector_kafka_version_minor+}"
 sink-connector="MongoDB Kafka sink connector"
 source-connector="MongoDB Kafka source connector"
+sink-connector-title="MongoDB Kafka Sink Connector"
+source-connector-title="MongoDB Kafka Source Connector"
 connector_driver_url_base="https://www.mongodb.com/docs/drivers/java/sync/v{+connector_driver_version+}/"
 connector_driver_api_doc_url_base="https://mongodb.github.io/mongo-java-driver/{+connector_driver_version+}/"
 pipeline-size = "2.4 GB"

source/compatibility.txt

@@ -9,20 +9,20 @@ Compatibility
 MongoDB Compatibility
 ---------------------
 
-Kafka Sink Connector
-~~~~~~~~~~~~~~~~~~~~
+{+sink-connector-title}
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-The **Kafka Sink Connector** requires MongoDB 3.6 or later.
+The {+sink-connector+} requires MongoDB v3.6 or later.
 
-Kafka Source Connector
-~~~~~~~~~~~~~~~~~~~~~~
+{+source-connector-title}
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-The **Kafka Source Connector** requires MongoDB 3.6 or later. 
+The {+source-connector+} requires MongoDB v3.6 or later.
 
-If you are using MongoDB 3.6, the connector can only listen for
+If you are using MongoDB v3.6, the connector can only listen for
 changes on **collections**. If you need the connector to listen for
 changes on a **database** or **deployment**, you must use
-MongoDB 4.0 or later.
+MongoDB v4.0 or later.
 
 .. note::
 
@@ -33,20 +33,20 @@ MongoDB 4.0 or later.
 Kafka Compatibility
 -------------------
 
-The **{+mkc+}** requires Kafka Connect version 2.1.0 or later. It's
-tested against Apache Kafka 2.3 and later. You can use the Kafka
+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:
 
-- Confluent Platform 5.3 or later
+- 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 {+mkc+} 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.
+Apache Kafka platform that supports {+kafka-connect+}.
 
-If you have any questions about the {+mkc+}, feel free to ask them on
-the `MongoDB Community Forums
+If you have any questions about the {+mkc+}, ask them on the 
+`MongoDB Community Forums
 <https://www.mongodb.com/community/forums/c/data/connectors-integrations/>`__.
 

source/includes/tutorials/setup.rst

@@ -1,4 +1,2 @@
-.. note:: Before You Get Started
-
-   Before you start this tutorial, you must complete the steps in the
-   :ref:`<kafka-tutorials-docker-setup>`.
+Complete the steps in the :ref:`<kafka-tutorials-docker-setup>` to start the
+the {+kafka-connect+} and MongoDB environment.

source/tutorials/explore-change-streams.txt

@@ -13,14 +13,18 @@ Explore MongoDB Change Streams
 Follow this tutorial to learn how to create a change stream on a MongoDB
 collection and observe the change events it creates.
 
-.. include:: /includes/tutorials/setup.rst
+
 
 Explore Change Streams
 ----------------------
 
 .. procedure::
    :style: connected
 
+   .. step:: Complete the Tutorial Setup
+
+      .. include:: /includes/tutorials/setup.rst
+
    .. step:: Connect to the Docker Container
 
       Create two interactive shell sessions on the tutorial Docker

source/tutorials/migrate-time-series.txt

@@ -40,14 +40,15 @@ stock performance over time using aggregation operators.
    tutorial. MongoDB developers are currently working on resolving this
    issue.
 
-.. include:: /includes/tutorials/setup.rst
-
 Migrate a Collection to a Time Series Collection
 ------------------------------------------------
 
 .. procedure::
    :style: connected
 
+   .. step:: Complete the Tutorial Setup
+
+      .. include:: /includes/tutorials/setup.rst
 
    .. step:: Generate Sample Data
 

source/tutorials/replicate-with-cdc.txt

@@ -30,14 +30,16 @@ data to the target MongoDB collection.
 If you want to learn more about how CDC handlers work, see the
 :ref:`<sink-fundamentals-cdc-handler>` guide.
 
-.. include:: /includes/tutorials/setup.rst
-
 Replicate Data with a CDC Handler
 ---------------------------------
 
 .. procedure::
    :style: connected
 
+   .. step:: Complete the Tutorial Setup
+
+      .. include:: /includes/tutorials/setup.rst
+
    .. step:: Start Interactive Shells
 
       Start two interactive shells on the Docker container in separate

source/tutorials/sink-connector.txt

@@ -14,14 +14,16 @@ Follow this tutorial to learn how to configure a {+sink-connector+}
 to read data from an Apache Kafka topic and write it to a MongoDB
 collection.
 
-.. include:: /includes/tutorials/setup.rst
-
 Get Started with the MongoDB Kafka Sink Connector
 -------------------------------------------------
 
 .. procedure::
    :style:connected
 
+   .. step:: Complete the Tutorial Setup
+
+      .. include:: /includes/tutorials/setup.rst
+
    .. step:: Configure the Sink Connector
 
       Create an interactive shell session on the tutorial Docker Container

source/tutorials/source-connector.txt

@@ -13,14 +13,16 @@ Getting Started with the MongoDB Kafka Source Connector
 Follow this tutorial to learn how to configure a {+source-connector+}
 to read data from a change stream and publish it to an Apache Kafka topic.
 
-.. include:: /includes/tutorials/setup.rst
-
 Get Started with the MongoDB Kafka Source Connector
 ---------------------------------------------------
 
 .. procedure::
    :style: connected
 
+   .. step:: Complete the Tutorial Setup
+
+      .. include:: /includes/tutorials/setup.rst
+
    .. step:: Configure the Source Connector
 
       Create an interactive shell session on the tutorial Docker container