[ https://issues.apache.org/jira/browse/KAFKA-16467?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17837928#comment-17837928 ]
ASF GitHub Bot commented on KAFKA-16467: ---------------------------------------- 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. > Add README to docs folder > ------------------------- > > Key: KAFKA-16467 > URL: https://issues.apache.org/jira/browse/KAFKA-16467 > Project: Kafka > Issue Type: Improvement > Reporter: PoAn Yang > Assignee: PoAn Yang > Priority: Minor > > We don't have a guide in project root folder or docs folder to show how to > run local website. It's good to provide a way to run document with kafka-site > repository. > > Option 1: Add links to wiki page > [https://cwiki.apache.org/confluence/display/KAFKA/Contributing+Website+Documentation+Changes] > and > [https://cwiki.apache.org/confluence/pages/viewpage.action?pageId=67634793]. > Option 2: Show how to run the document within container. For example: moving > `site-docs` from kafka to kafka-site repository and run `./start-preview.sh`. -- This message was sent by Atlassian Jira (v8.20.10#820010)