The website documentation of Kafka resides in a few different places.
KafkaConfig.java
, ProducerConfig.java
, ConsumerConfig.java
etc).There are a number of ways to preview edits on the web docs
start-preview.sh
script in the website repo. This requires you have Docker or Podman installed. Running the script will create a container image containing httpd and the necessary server config. You then just need to point your browser at localhost:8080.Alternatively, 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),
You can also 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).