commit | b69546a844138208a095855020dc651088ba8ce7 | [log] [tgz] |
---|---|---|
author | David Arthur <mumrah@gmail.com> | Mon Jun 24 12:39:43 2024 -0400 |
committer | David Arthur <mumrah@gmail.com> | Mon Jun 24 12:43:21 2024 -0400 |
tree | 526bb891c98b7cc5ba7fb977a3d2be58e9c96c7c | |
parent | 942336301dbfe7ad5e1fe521751855f9aac06d1b [diff] |
add a note about migration bugs for 3.6.0
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.