You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on May 2, 2023. It is now read-only.
Copy file name to clipboardExpand all lines: docs/contributing.rst
+4-8Lines changed: 4 additions & 8 deletions
Original file line number
Diff line number
Diff line change
@@ -8,19 +8,15 @@ General Guidelines
8
8
9
9
When submitting a pull request (PR), please use the following guidelines:
10
10
11
-
* Make sure your code respects existing formatting conventions. In general, follow
12
-
the same coding style as the code that you are modifying.
11
+
* Make sure your code respects existing formatting conventions. In general, follow the same coding style as the code that you are modifying.
13
12
* Do add/update documentation appropriately for the change you are making.
14
-
* If you are introducing a new feature you may want to first submit your idea
15
-
for feedback to the `Confluent mailing list <mailto:partner-support@confluent.io>`_.
13
+
* If you are introducing a new feature you may want to first submit your idea for feedback to the `Confluent mailing list <mailto:partner-support@confluent.io>`_.
16
14
* Non-trivial features should include unit tests covering the new functionality.
17
15
* Bugfixes should include a unit test or integration test reproducing the issue.
18
-
* Try to keep pull requests short and submit separate ones for unrelated
19
-
features, but feel free to combine simple bugfixes/tests into one pull request.
16
+
* Try to keep pull requests short and submit separate ones for unrelated features, but feel free to combine simple bugfixes/tests into one pull request.
20
17
* Keep the number of commits small and combine commits for related changes.
21
18
* Each commit should compile on its own and ideally pass tests.
22
-
* Keep formatting changes in separate commits to make code reviews easier and
23
-
distinguish them from actual code changes.
19
+
* Keep formatting changes in separate commits to make code reviews easier and distinguish them from actual code changes.
Copy file name to clipboardExpand all lines: docs/development.rst
+13-12Lines changed: 13 additions & 12 deletions
Original file line number
Diff line number
Diff line change
@@ -120,9 +120,7 @@ To get started, you can build all the CP images as follows:
120
120
121
121
make build-debian
122
122
123
-
You can run build tests by running ``make test-build``. Use this when
124
-
you want to test the builds with a clean slate. This deletes all images
125
-
and starts from scratch.
123
+
You can run build tests by running ``make test-build``. Use this when you want to test the builds with a clean slate. This deletes all images and starts from scratch.
126
124
127
125
.. _running_tests :
128
126
@@ -151,7 +149,7 @@ To run a single test, you can do so with Python. In the following example, we r
151
149
Make Targets
152
150
~~~~~~~~~~~~
153
151
154
-
Deletes all images tagged with ``label=io.confluent.docker.testing=true`` :
152
+
Delete all images tagged with ``label=io.confluent.docker.testing=true`` :
155
153
156
154
``clean-images``
157
155
@@ -184,17 +182,23 @@ config management, use service discovery etc. This page provides instructions f
184
182
Prerequisites
185
183
~~~~~~~~~~~~
186
184
187
-
1. Read the section on :ref:`development <development>` to setup the development
188
-
environment to build docker images.
189
-
2. Understand how the images are structured by reading the following
190
-
docs:
185
+
1. Read the section on :ref:`development <development>` to setup the development environment to build docker images.
186
+
2. Understand how the images are structured by reading the following docs:
191
187
192
188
- ``image-structure`` describes the structure of the images
193
189
- ``utility_scripts`` describes the utility scripts used in the
194
190
images
195
191
196
192
3. If you plan to contribute back to the project, please be sure to review our guide on :ref:`contributing <contributing_guide>`.
197
193
194
+
Adding Connectors to the Kafka Connect Image
195
+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
196
+
197
+
There are currently two ways to add new connectors to the Kafka Connect image.
198
+
199
+
* Build a new Docker image that has connector installed. You can follow example 2 in the documentation below. You will need to make sure that the connector jars are on the classpath.
200
+
* Add the connector jars via volumes. If you don't want to create a new Docker image, please see our documentation on `Configuring Kafka Connect with External Jars <operations/external-volumes.html>`_ to configure the `cp-kafka-connect` container with external jars.
201
+
198
202
.. _examples :
199
203
200
204
Examples
@@ -206,8 +210,6 @@ The following examples show to extend the images.
206
210
207
211
This example shows how to change the configuration management. You will need to override the ``configure`` script to download the scripts from an HTTP URL.
208
212
209
-
For example:
210
-
211
213
To do this for the Zookeeper image, you will need the following dockerfile and configure script. This example assumes that each property file is has a URL.
212
214
213
215
``Dockerfile``
@@ -255,7 +257,7 @@ The following examples show to extend the images.
This example shows how to add new software to an image. For example, you might want to extend the Kafka Connect client to include the MySQL JDBC driver.
261
263
@@ -741,7 +743,6 @@ The following properties may be configured when using the ``kafka-ready`` utilit
0 commit comments