[GitHub] [kafka-site] mimaison commented on a diff in pull request #410: KAFKA-13882 Docker to preview docs locally

[GitBox <gi...@apache.org>]

mimaison commented on code in PR #410:
URL: https://github.com/apache/kafka-site/pull/410#discussion_r871522164


##########
README.md:
##########
@@ -0,0 +1,11 @@
+# How to preview the documentation changes locally?
+
+The documentation can hosted on a local webserver via httpd.
+
+You can run it with the following command, note that it requires docker:
+
+```shell
+sh start-preview.sh
+```
+
+Then you can open localhost:8080 on your browser and browse the documentation

Review Comment:
   Can we make a link for localhost:8080?
   Also let's add a full stop at the end of the sentence



##########
README.md:
##########
@@ -0,0 +1,11 @@
+# How to preview the documentation changes locally?

Review Comment:
   We can drop `the` here



##########
start-preview.sh:
##########
@@ -0,0 +1,9 @@
+#!/usr/bin/env bash
+
+set -euxo pipefail
+
+docker build -t kafka-site-preview .
+
+docker run -dit --rm --name mypreview -p 8080:80 -v "$PWD":/usr/local/apache2/htdocs/ kafka-site-preview
+
+echo "You can stop the preview server by running `docker stop mypreview"

Review Comment:
   Can we close the backtick and also add a new line?



##########
README.md:
##########
@@ -0,0 +1,11 @@
+# How to preview the documentation changes locally?
+
+The documentation can hosted on a local webserver via httpd.

Review Comment:
   `The documentation can hosted` -> `The documentation can be hosted`



##########
README.md:
##########
@@ -0,0 +1,11 @@
+# How to preview the documentation changes locally?
+
+The documentation can hosted on a local webserver via httpd.
+
+You can run it with the following command, note that it requires docker:
+
+```shell
+sh start-preview.sh

Review Comment:
   Can we make the script executable and call `./start-preview.sh`?



-- 
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-unsubscribe@kafka.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org