[ 
https://issues.apache.org/jira/browse/KAFKA-13882?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17536212#comment-17536212
 ] 

ASF GitHub Bot commented on KAFKA-13882:
----------------------------------------

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


##########
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:
   Hi, does this means users have to run chmod +x themselves?
   



##########
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:
   Hi, does this means users have to run chmod +x?
   





> 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)

Reply via email to