[KAFKA-16467] Add README to docs folder

• Type: Improvement
• Status: Resolved
• Priority: Minor
• Resolution: Fixed
• Fix Version/s: 3.8.0
• Assignee: PoAn Yang
• Reporter: PoAn Yang
• Created: 03/Apr/24 02:32
• Updated: 30/Apr/24 02:26
• Resolved: 30/Apr/24 02:26

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`.

Issue Links

• links to: GitHub Pull Request #15664