commit | 66eaf354f2c9ee0496405ee4f300c17a70c92b29 | [log] [tgz] |
---|---|---|
author | Josep Prat <josep.prat@aiven.io> | Fri Jul 26 09:54:00 2024 +0200 |
committer | Josep Prat <josep.prat@aiven.io> | Fri Jul 26 09:54:00 2024 +0200 |
tree | 17a564503c75e2ef2fe12f324b2431e54529b268 | |
parent | 00c255e600a3e5432b320b72ddaf3148e15830f7 [diff] |
MINOR: Update Javadoc for 3.8 without SNAPSHOT
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.