[
https://issues.apache.org/jira/browse/KAFKA-16467?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]
PoAn Yang updated KAFKA-16467:
------------------------------
Description:
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`.
was: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.
> 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)
