[
https://issues.apache.org/jira/browse/KAFKA-13882?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17536197#comment-17536197
]
ASF GitHub Bot commented on KAFKA-13882:
----------------------------------------
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`?
> Dockerfile for previewing website
> ---------------------------------
>
> Key: KAFKA-13882
> URL: https://issues.apache.org/jira/browse/KAFKA-13882
> Project: Kafka
> Issue Type: Task
> Components: docs, website
> Reporter: Tom Bentley
> Assignee: Lim Qing Wei
> Priority: Trivial
> Labels: newbie
>
> Previewing changes to the website/documentation is rather difficult because
> you either have to [hack with the
> HTML|https://cwiki.apache.org/confluence/display/KAFKA/Contributing+Website+Documentation+Changes#ContributingWebsiteDocumentationChanges-KafkaWebsiteRepository]
> or [install
> httpd|https://cwiki.apache.org/confluence/display/KAFKA/Setup+Kafka+Website+on+Local+Apache+Server].
> This is a barrier to contribution.
> Having a Dockerfile for previewing the Kafka website (i.e. with httpd
> properly set up) would make it easier for people to contribute website/docs
> changes.
--
This message was sent by Atlassian Jira
(v8.20.7#820007)
