commit | d01775be3fd5963d4ea5584a8b6aa42c7b00b4e7 | [log] [tgz] |
---|---|---|
author | Shashank <hsshashank.grad@gmail.com> | Mon Oct 06 15:45:37 2025 -0700 |
committer | GitHub <noreply@github.com> | Mon Oct 06 15:45:37 2025 -0700 |
tree | 62e67bc2deaefd7c1eabec097fb3c914c7fd8a7c | |
parent | 84189283c97bceeedd208b86e08438cfdb986f63 [diff] |
MINOR: add note about KS memory leak bug (#729)
The documentation can be hosted on a local webserver via httpd.
You can run it with the following command, note that it requires docker:
./start-preview.sh
Then you can open localhost:8080 on your browser and browse the documentation.
To kill the process, just type ctrl + c.
# change directory into kafka repository cd KAFKA_REPO ./gradlew clean siteDocTar # supposing built with scala 2.13 tar zxvf core/build/distributions/kafka_2.13-$(./gradlew properties | grep version: | awk '{print $NF}' | head -n 1)-site-docs.tgz
# change directory into kafka-site repository cd KAFKA_SITE_REPO # copy the generated documents into dev folder rm -rf dev mkdir dev cp -r KAFKA_REPO/site-docs/* dev # preview it ./start-preview.sh
Then you can open http://localhost:8080/dev/documentation/ on your browser and browse the generated documentation.