commit | 6255e47989ba2a67ff513d25239e4345b418f2f7 | [log] [tgz] |
---|---|---|
author | Igor Soarez <i@soarez.me> | Wed Apr 24 09:44:57 2024 +0100 |
committer | GitHub <noreply@github.com> | Wed Apr 24 09:44:57 2024 +0100 |
tree | 0f168a3fa8d46ebf9e421d82766f4fab124cf5a6 | |
parent | f0f2dc9ac8b4d7982bc5426bbce1436046e0ecb8 [diff] |
MINOR: Add Igor to committers (#598) Reviewers: Justine Olshan <jolshan@confluent.io>, Luke Chen <showuon@gmail.com>, David Jacot <djacot@confluent.io>, Satish Duggana <satishd@apache.org>
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.