You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 8 Next »

 

  • 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 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 repo. We 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.

  • In some cases, like hot fixes, non-technical web page changes, we accept Github pull requests against website git repo. 
  • No labels