Development

Install

Build from source

  • Import as Maven project

  • Generate the jar file

    mvn package

  • Copy the jar file target/kafka-connect-datagen-$version.jar to a Kafka Connect worker’s classpath

Docs

Update connector configs

Connector configurations are defined as ConfigDef objects. To convert the code-level definitions to documentation files, run

mvn clean compile test -Pgenerate-config-docs

Update user guide

We write user guide in ReStructuredText and use Sphinx to generate static HTML pages.

  • Install Sphinx in a Python virtualenv

  • Activate the virtualenv and run

    sphinx-build -b html docs/ docs/_build

  • Open docs/_build/index.html in browser to view the updated version.