Skip to content

Commit 693e67b

Browse files
biniona-mongodbChris Cho
authored andcommitted
(DOCSP-19203) Port Quickstart Update (#188)
Co-authored-by: Chris Cho <[email protected]>
1 parent 3ae981b commit 693e67b

File tree

5 files changed

+171
-137
lines changed

5 files changed

+171
-137
lines changed

snooty.toml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,3 +16,4 @@ connector_driver_version="4.3"
1616
sink-connector="MongoDB Kafka sink connector"
1717
source-connector="MongoDB Kafka source connector"
1818
connector_driver_url_base="https://docs.mongodb.com/drivers/java/sync/v{+connector_driver_version+}/"
19+
pipeline-size = "2.4 GB"

source/includes/tutorials/download-note.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
.. note:: How long does the download take?
22

3-
In total, the Docker images for this tutorial require about 2.4 GB of space.
4-
The following list shows how long it takes to download the images with
3+
In total, the Docker images for this tutorial require about {+pipeline-size+}
4+
of space. The following list shows how long it takes to download the images with
55
different internet speeds:
66

77
- 40 megabits per second: 8 minutes
Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,12 @@
11
We provide you with a sample data pipeline so that you can use the MongoDB
2-
Kafka Connector. To access and use the files that define your sample data pipeline,
3-
clone the tutorial repository and change your directory to the root of the
4-
repository using the following commands:
2+
Kafka Connector.
53

6-
<TODO: decide on final location for this example>
4+
Use bash or a similar shell to run the shell commands in this guide. To download
5+
the files that define your sample data pipeline, clone the tutorial
6+
repository and navigate into the tutorial directory using the
7+
following commands:
78

89
.. code-block:: bash
910
10-
git clone https://github.com/biniona-mongodb/MongoKafkaLite
11-
cd MongoKafkaLite
11+
git clone https://github.com/mongodb-university/kafka-edu.git
12+
cd kafka-edu/docs-examples/v1.6/quickstart
Lines changed: 15 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,21 @@
1-
This guide uses the following tools:
1+
Download and install the following tools:
22

33
- `Docker Platform <https://docs.docker.com/get-docker/>`__
44
- `Git <https://git-scm.com/book/en/v2/Getting-Started-Installing-Git>`__
55

6-
If you do not have any of these tools installed on your computer, you
7-
can install a tool by clicking on the tool's name and following the linked
8-
installation instructions.
9-
106
.. tip:: Read the Docker Documentation
117

12-
This guide uses some Docker specific terminology. If you are new to Docker
13-
and would like a comprehensive introduction, read through Docker's official
14-
`Get Started Guide <https://docs.docker.com/get-started/>`__.
8+
This guide uses the following Docker specific terminology:
9+
10+
- `Container <https://docs.docker.com/glossary/#container>`__
11+
- `Image <https://docs.docker.com/glossary/#image>`__
12+
13+
If you are new to Docker and would like a comprehensive introduction, see
14+
Docker's official
15+
`Get Started Guide <https://docs.docker.com/get-started/>`__.
16+
17+
The sample pipeline uses Docker for simplicity of setup. To learn more about
18+
deployment options for {+ak+}, see the following resources:
19+
20+
- Official `{+ak+} Quick Start <https://kafka.apache.org/quickstart>`__
21+
- Confluent's `Install Confluent Platform <https://docs.confluent.io/platform/current/installation/index.html>`__ page

0 commit comments

Comments
 (0)