commit | f0f2dc9ac8b4d7982bc5426bbce1436046e0ecb8 | [log] [tgz] |
---|---|---|
author | PoAn Yang <yangpoan@gmail.com> | Thu Apr 18 11:15:39 2024 +0800 |
committer | GitHub <noreply@github.com> | Thu Apr 18 11:15:39 2024 +0800 |
tree | e1bad33e43a182e0123061919becb39ff36d621a | |
parent | 821835a5e46e2acaccf0ec1ef8c4b5b60d9d0152 [diff] |
KAFKA-16467: add how to integrate with kafka repo (#596) ref: https://issues.apache.org/jira/browse/KAFKA-16467 Signed-off-by: PoAn Yang <payang@apache.org> Reviewers: Luke Chen <showuon@gmail.com>
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.