showuon commented on code in PR #596: URL: https://github.com/apache/kafka-site/pull/596#discussion_r1568111065
########## README.md: ########## @@ -10,4 +10,32 @@ You can run it with the following command, note that it requires docker: Then you can open [localhost:8080](http://localhost:8080) on your browser and browse the documentation. -To kill the process, just type ctrl + c \ No newline at end of file +To kill the process, just type ctrl + c. + +## How to preview the latest documentation changes in Kafka repository? + +1. Generating document from kafka repository: + +```shell +# 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 +``` + +2. Copying the generated documents from Kafka repository into kafka-site, and preview them (note that it requires docker): + +```shell +# change directory into kafka-site repository +cd KAFKA_SITE_REPO +# copy the generated documents into dev folder +rm -rf dev +mkdir dev +# change directory into kafka repository +cp -r KAFKA_REPO/site-docs/* dev Review Comment: I don't think this comment is correct. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
