Skip to content

Commit 65e4eae

Browse files
Chris Choschmalliso
authored andcommitted
DOCSP-9232: Add changelog link in the left nav (#8)
* DOCSP-9232: Add a Changelog link in the left nav, update code block highlighting to 'none'
1 parent 0f2c40e commit 65e4eae

File tree

6 files changed

+16
-15
lines changed

6 files changed

+16
-15
lines changed

source/index.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,7 @@ This guide is divided into the following topics:
3838
Source Connector Guide </kafka-source>
3939
Kafka Docker Example </kafka-docker-example>
4040
Migrate from Kafka Connect </kafka-connect-migration>
41+
Changelog <https://github.com/mongodb/mongo-kafka/blob/master/CHANGELOG.md>
4142

4243
For questions or issues , visit our :community-support:`Community Support
4344
Resources </>`.

source/kafka-docker-example.txt

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -75,19 +75,19 @@ How to Run the Example
7575
Clone the `mongo-kafka <https://github.com/mongodb/mongo-kafka>`_ repository
7676
from GitHub:
7777

78-
.. code-block:: shell
78+
.. code-block:: none
7979

8080
git clone https://github.com/mongodb/mongo-kafka.git
8181

8282
Change directory to the ``docker`` directory
8383

84-
.. code-block:: shell
84+
.. code-block:: none
8585

8686
cd mongo-kafka/docker/
8787

8888
Start the shell script, **run.sh**:
8989

90-
.. code-block:: shell
90+
.. code-block:: none
9191

9292
./run.sh
9393

@@ -117,7 +117,7 @@ The shell script executes the following sequence of commands:
117117
.. note::
118118

119119
You may need to increase the RAM resource limits for Docker if the script
120-
fails. Use the `docker-compose stop <docker-compose-stop>` command to
120+
fails. Use the :ref:`docker-compose stop <docker-compose-stop>` command to
121121
stop any running instances of docker if the script did not complete
122122
successfully.
123123

@@ -188,7 +188,7 @@ Next, explore the collection data in the MongoDB replica set:
188188
ran the ``docker-compose`` commands and connect to the `mongo1` MongoDB
189189
instance using the following command:
190190

191-
.. code-block:: shell
191+
.. code-block:: none
192192

193193
docker-compose exec mongo1 /usr/bin/mongo
194194

@@ -201,13 +201,13 @@ Next, explore the collection data in the MongoDB replica set:
201201
To stop the docker containers and all the processes running on them, use
202202
Ctrl-C in the shell running the script, or the following command:
203203

204-
.. code-block:: shell
204+
.. code-block:: none
205205

206206
docker-compose stop
207207

208208
To remove the docker containers and images completely, use the following
209209
command:
210210

211-
.. code-block:: shell
211+
.. code-block:: none
212212

213213
docker-compose down

source/kafka-sink-data-formats.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -133,7 +133,7 @@ object.
133133

134134
The MongoDB Kafka Connector converts the ``SinkRecord`` into
135135
a ``SinkDocument`` which contains the key and value in BSON format. The
136-
convertor determines the types using schema, if provided.
136+
converter determines the types using schema, if provided.
137137

138138
The connector supports all the core schema types listed in
139139
:kafka-21-javadoc:`Schema.Type </connect/data/Schema.Type.html>`:

source/kafka-sink-postprocessors.txt

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,7 @@ class:
8080

8181
* - RenameByRegex
8282
- | Full Path: ``com.mongodb.kafka.connect.sink.processor.field.renaming.RenameByRegex``
83-
| Renames fields that match a regular expresion.
83+
| Renames fields that match a regular expression.
8484

8585
.. seealso:: :ref:`Renaming configuration <config-field-renaming>` and :ref:`Example <field-renaming-regex-example>`.
8686

@@ -698,7 +698,7 @@ airport it is currently located represented by ``flight_no`` and
698698
In order to implement the strategy, we first create a unique index on the
699699
``flight_no`` and ``airport_code`` fields in the MongoDB shell:
700700

701-
.. code-block:: shell
701+
.. code-block:: none
702702

703703
db.collection.createIndex({ "flight_no": 1, "airport_code": 1}, { unique: true })
704704

@@ -836,4 +836,4 @@ After an hour, the train reports its current location along its route. The
836836
"start": "Beacon",
837837
"destination": "Grand Central"
838838
"position": [ 41.156, -73.870 ]
839-
}
839+
}

source/kafka-sink-properties.txt

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ data to sink to MongoDB. For an example configuration file, see
4444

4545
.. example::
4646

47-
.. code-block:: shell
47+
.. code-block:: none
4848

4949
mongodb://username:password@localhost/
5050

@@ -113,7 +113,7 @@ data to sink to MongoDB. For an example configuration file, see
113113

114114
.. example::
115115

116-
.. code-block:: shell
116+
.. code-block:: none
117117

118118
[ { "oldName":"key.fieldA", "newName":"field1" }, { "oldName":"value.xyz", "newName":"abc" } ]
119119

@@ -126,7 +126,7 @@ data to sink to MongoDB. For an example configuration file, see
126126

127127
.. example::
128128

129-
.. code-block:: shell
129+
.. code-block:: none
130130

131131
[ {"regexp":"^key\\\\..*my.*$", "pattern":"my", "replace":""}, {"regexp":"^value\\\\..*$", "pattern":"\\\\.", "replace":"_"} ]
132132

source/kafka-source.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -134,7 +134,7 @@ an example source connector configuration file, see
134134

135135
.. example::
136136

137-
.. code-block:: shell
137+
.. code-block:: none
138138

139139
[{"$match": {"operationType": "insert"}}, {"$addFields": {"Kafka": "Rules!"}}]
140140

0 commit comments

Comments
 (0)