showuon commented on code in PR #596:
URL: https://github.com/apache/kafka-site/pull/596#discussion_r1565129468
##
README.md:
##
@@ -10,4 +10,30 @@ 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.
+
+## Preview latest kafka document
+
+1. Assume you have [kafka](https://github.com/apache/kafka) and kafka-site
folder structure like this:
+
+```shell
+.
+├── kafka
+└── kafka-site
+```
+
+2. Generate document in kafka folder:
Review Comment:
Generate document in kafka folder: -> Generating document from kafka
repository:
##
README.md:
##
@@ -10,4 +10,30 @@ 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.
+
+## Preview latest kafka document
+
+1. Assume you have [kafka](https://github.com/apache/kafka) and kafka-site
folder structure like this:
+
+```shell
+.
+├── kafka
+└── kafka-site
+```
+
Review Comment:
I think we don't need to have this assumption.
##
README.md:
##
@@ -10,4 +10,30 @@ 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.
+
+## Preview latest kafka document
Review Comment:
We could be consistent with the L1 title. Ex:
`How to preview the latest documentation changes in Kafka repository?`
##
README.md:
##
@@ -10,4 +10,30 @@ 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.
+
+## Preview latest kafka document
+
+1. Assume you have [kafka](https://github.com/apache/kafka) and kafka-site
folder structure like this:
+
+```shell
+.
+├── kafka
+└── kafka-site
+```
+
+2. Generate document in kafka folder:
+
+```shell
+./gradlew clean siteDocTar
+tar zxvf core/build/distributions/kafka_2.13-$(./gradlew properties | grep
version: | awk '{print $NF}' | head -n 1)-site-docs.tgz
+```
+
+3. Running website in kafka-site folder and open
[http://localhost:8080/dev/documentation/](http://localhost:8080/dev/documentation/):
+
+```shell
+rm -rf dev
+mkdir dev
+cp -r ../kafka/site-docs/* dev
+./start-preview.sh
+```
Review Comment:
How about this:
3. Copying the generated documents in 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
cp -r ../kafka/site-docs/* dev
# preview it
./start-preview.sh
```
Then you can open
[http://localhost:8080/dev/documentation/](http://localhost:8080/dev/documentation/)
on your browser and browse the generated documentation.
##
README.md:
##
@@ -10,4 +10,30 @@ 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.
+
+## Preview latest kafka document
+
+1. Assume you have [kafka](https://github.com/apache/kafka) and kafka-site
folder structure like this:
+
+```shell
+.
+├── kafka
+└── kafka-site
+```
+
+2. Generate document in kafka folder:
+
+```shell
+./gradlew clean siteDocTar
+tar zxvf core/build/distributions/kafka_2.13-$(./gradlew properties | grep
version: | awk '{print $NF}' | head -n 1)-site-docs.tgz
+```
Review Comment:
We didn't mention we are in kafka repo now. How about this:
```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
```
--
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: dev-unsubscr...@kafka.apache.org
For queries about this service, please contact Infrastructure at:
us...@infra.apache.org
