Child pages
  • Contributing Website Documentation Changes
Skip to end of metadata
Go to start of metadata

The website documentation of Kafka reside in a few different places.

Kafka Code Repository

  • Kafka code repo has a /docs directory with the latest revision of the docs (not multiple versions, just one that matches the latest state of code).

  • When you submit a code patch that requires doc modification, you modify all relevant files in same patch and they get reviewed and committed together (ideally). 

  • When you submit a doc patch alone, you modify all relevant files in docs/ directory and submit a patch.

  • Broker/new producer/new consumer configuration docs are auto-generated from code. So for any changes, you need to modify the relevant java files (KafkaConfig.java, ProducerConfig.java, ConsumerConfig.java etc).

  • Follow Contributing Code Changes for submitting above doc changes using Github pull requests.

  • When we release, we copy the docs matching the release and commit to website git repoWe also do this occasionally to fix bugs in earlier docs.

  • For older releases, contribute changes to the relevant branch of the release code repository and this will be pushed to the website git repo as needed.

Kafka Website Repository

  • The website git repo hosts some of the Kafka website pages that are not included in the Kafka code repository.

  • In some cases, like hot fixes, non-technical web page changes, we accept Github pull requests against website git repo.
     
  • If you want to check out the edits on the web docs, you can either setup your local web server to point to your kafka-site repo (it is a one time thing and will save you lots of time moving forward if you are going to continuously contributing to web doc changes), or extract the content inside the

    <script id="api-template" type="text/x-handlebars-template">
    
    ...
    
    </script>
    
    
    
    <div class="p-api"></div> 


    JavaScript wrapper in order to display it with a browser (it will lose the formatting decorations though).

Wiki Pages

  • Some documentation are simply wiki pages. In that case, we simply modify the wiki pages. (You may need permission to modify the wiki pages. Please send email to dev@kafka.apache.org or users@kafka.apache.org asking for the permission.)

 

  • No labels