You are viewing a plain text version of this content. The canonical link for it is here.

Posted to jira@kafka.apache.org by "Chia-Ping Tsai (Jira)" <ji...@apache.org> on 2024/04/03 10:54:00 UTC

[jira] [Commented] (KAFKA-16467) Add README to docs folder

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

Chia-Ping Tsai commented on KAFKA-16467:
----------------------------------------

Have you checked the option1? not sure whether it is valid now.

option2 seems be more simple than option1 to me

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