This page provides a step-by-step guide to set up the contents of the Kafka website (https://kafka.apache.org/) as your local Apache HTTP Server's homepage. This is useful when you are contributing documentation changes, for which you need verify that any modified pages of yours still display and render correctly. This Note that the start-preview.sh
script does what is described here within a Docker container: Most people will find start-preview.sh
easier and more convenient than following this guide. This guide is based on macOS, but should be easily adopted for other operating systems like Linux/Unix.
...
From now on, whenever you edited files in your local kafka-site fork, you should normally only need to refresh our browser (Cmd+R). If this is not sufficient, you can repeat the step above (i.e., restarting the webserver) to see your latest changes in your browser. Remember to refresh any browser tabsto restart the webserver.
Info |
---|
Important Note: Your documentation changes should most likely be made in the main Apache Kafka code repository (https://github.com/apache/kafka) instead of the |
...