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
confluentinc · Sep 7, 2016 · f1cce7c · f1cce7c
1 parent e75865d
commit f1cce7c
Show file tree

Hide file tree

Showing 16 changed files with 136 additions and 404 deletions.
diff --git a/docs/best-practices.rst b/docs/best-practices.rst
diff --git a/docs/connect-avro-jdbc.rst b/docs/connect-avro-jdbc.rst
diff --git a/docs/contributing.rst b/docs/contributing.rst
@@ -8,19 +8,15 @@ General Guidelines
 
 When submitting a pull request (PR), please use the following guidelines:
 
-* Make sure your code respects existing formatting conventions. In general, follow
-  the same coding style as the code that you are modifying.
+* Make sure your code respects existing formatting conventions. In general, follow the same coding style as the code that you are modifying.
 * Do add/update documentation appropriately for the change you are making.
-* 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>`_.
+* 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>`_.
 * Non-trivial features should include unit tests covering the new functionality.
 * Bugfixes should include a unit test or integration test reproducing the issue.
-* 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.
+* 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.
 * Keep the number of commits small and combine commits for related changes.
 * Each commit should compile on its own and ideally pass tests.
-* Keep formatting changes in separate commits to make code reviews easier and
-  distinguish them from actual code changes.
+* Keep formatting changes in separate commits to make code reviews easier and distinguish them from actual code changes.
 
 GitHub Workflow
 ~~~~~~~~~~~~~~

diff --git a/docs/development.rst b/docs/development.rst
@@ -120,9 +120,7 @@ To get started, you can build all the CP images as follows:
 
     make build-debian
 
-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.
+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.
 
 .. _running_tests : 
 
@@ -151,7 +149,7 @@ To run a single test, you can do so with Python.  In the following example, we r
 Make Targets
 ~~~~~~~~~~~~
 
-Deletes all images tagged with ``label=io.confluent.docker.testing=true`` :
+Delete all images tagged with ``label=io.confluent.docker.testing=true`` :
 
 ``clean-images`` 
 
@@ -184,17 +182,23 @@ config management, use service discovery etc.  This page provides instructions f
 Prerequisites
 ~~~~~~~~~~~~
 
-1. Read the section on :ref:`development <development>` to setup the development
-   environment to build docker images.
-2. Understand how the images are structured by reading the following
-   docs:
+1. Read the section on :ref:`development <development>` to setup the development environment to build docker images.
+2. Understand how the images are structured by reading the following docs:
 
    -  ``image-structure`` describes the structure of the images
    -  ``utility_scripts`` describes the utility scripts used in the
       images
 
 3. If you plan to contribute back to the project, please be sure to review our guide on :ref:`contributing <contributing_guide>`.
 
+Adding Connectors to the Kafka Connect Image
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+There are currently two ways to add new connectors to the Kafka Connect image.  
+
+* 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. 
+* 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.
+
 .. _examples :
 
 Examples
@@ -206,8 +210,6 @@ The following examples show to extend the images.
 
   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.
 
-  For example:
-
   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.
 
   ``Dockerfile``
@@ -255,7 +257,7 @@ The following examples show to extend the images.
            -e ZOOKEEPER_LOG_CONFIG_URL =http://foo.com/zk1/log4j.properties \
            foo/zookeeper:latest
 
-2. Add more software
+2. Add More Software
 
   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.
 
@@ -741,7 +743,6 @@ The following properties may be configured when using the ``kafka-ready`` utilit
   * Default: "PKIX"
   * Importance: low
 
-
 .. _references : 
 
 References

diff --git a/docs/index.rst b/docs/index.rst
@@ -3,8 +3,8 @@
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 
-CP Docker Images
-================
+Docker
+======
 
 Contents: