Skip to content
This repository was archived by the owner on May 2, 2023. It is now read-only.

Commit f1cce7c

Browse files
authored
Fixing links & Security tutorials (#128)
* fixing broken links * adding alex's changes and notes on extending to add connectors * adding more language about extending images
1 parent e75865d commit f1cce7c

16 files changed

+136
-404
lines changed

docs/best-practices.rst

Lines changed: 0 additions & 16 deletions
This file was deleted.

docs/connect-avro-jdbc.rst

Lines changed: 0 additions & 254 deletions
This file was deleted.

docs/contributing.rst

Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -8,19 +8,15 @@ General Guidelines
88

99
When submitting a pull request (PR), please use the following guidelines:
1010

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.
1312
* 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>`_.
1614
* Non-trivial features should include unit tests covering the new functionality.
1715
* 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.
2017
* Keep the number of commits small and combine commits for related changes.
2118
* 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.
2420

2521
GitHub Workflow
2622
~~~~~~~~~~~~~~

docs/development.rst

Lines changed: 13 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -120,9 +120,7 @@ To get started, you can build all the CP images as follows:
120120

121121
make build-debian
122122

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.
126124

127125
.. _running_tests :
128126

@@ -151,7 +149,7 @@ To run a single test, you can do so with Python. In the following example, we r
151149
Make Targets
152150
~~~~~~~~~~~~
153151

154-
Deletes all images tagged with ``label=io.confluent.docker.testing=true`` :
152+
Delete all images tagged with ``label=io.confluent.docker.testing=true`` :
155153

156154
``clean-images``
157155

@@ -184,17 +182,23 @@ config management, use service discovery etc. This page provides instructions f
184182
Prerequisites
185183
~~~~~~~~~~~~
186184

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:
191187

192188
- ``image-structure`` describes the structure of the images
193189
- ``utility_scripts`` describes the utility scripts used in the
194190
images
195191

196192
3. If you plan to contribute back to the project, please be sure to review our guide on :ref:`contributing <contributing_guide>`.
197193

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+
198202
.. _examples :
199203

200204
Examples
@@ -206,8 +210,6 @@ The following examples show to extend the images.
206210

207211
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.
208212

209-
For example:
210-
211213
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.
212214

213215
``Dockerfile``
@@ -255,7 +257,7 @@ The following examples show to extend the images.
255257
-e ZOOKEEPER_LOG_CONFIG_URL =http://foo.com/zk1/log4j.properties \
256258
foo/zookeeper:latest
257259

258-
2. Add more software
260+
2. Add More Software
259261

260262
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.
261263

@@ -741,7 +743,6 @@ The following properties may be configured when using the ``kafka-ready`` utilit
741743
* Default: "PKIX"
742744
* Importance: low
743745

744-
745746
.. _references :
746747

747748
References

docs/index.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@
33
You can adapt this file completely to your liking, but it should at least
44
contain the root `toctree` directive.
55
6-
CP Docker Images
7-
================
6+
Docker
7+
======
88

99
Contents:
1010

0 commit comments

Comments
 (0)