Thanks for the KIP, Harish! I am +100 just on the title alone :)
The motivations in the KIP are sound. All of these are very real annoyances when it comes to maintaining our docs. I suspect we have not done anything to improve them since the system we have worked well enough in the past. A better way to say that is: it hasn't been bad enough to motivate us to change it. With efforts like this, there is always some question about which tool or method we should use. I like that your proposal includes these specifics as well as a complete and functional demo. Few questions: DA1) Do we really need to convert all of our docs to the new thing? It might be reasonable to draw a line somewhere (maybe 3.0?) and have docs prior to that be hosted elsewhere (kafka.apache.org/old or something). This may or may not be more work than just converting everything. WDYT? DA2) For our packaged docs (those that go in the binaries we distribute), do you think it's possible to render HTML that can be viewed without a webserver? Currently our packaged docs are kind of useless IMO. It would be better if they could be viewed without any extra effort by an operator. DA3) As a possible alternative to DA2, could we render the markdown docs as ascii text files? This is arguably better for operators since they don't always have a GUI or web browser handy. DA4) Just a nitpick, could you reduce the "Sample directory layout" down to one or two examples? It's difficult to see the versioned vs non-versioned docs in the current block Thanks! David A On Sun, Feb 16, 2025 at 2:10 PM Harish Vishwanath <harish.shas...@gmail.com> wrote: > Hello, > > Following up from my previous email regarding moving AK documentation to > markdown, I wrote KIP-1133 > < > https://cwiki.apache.org/confluence/display/KAFKA/KIP-1133%3A+AK+Documentation+and+Website+in+Markdown > > > detailing > the proposal and would like to start discussions. Please take a look. > > Regards, > Harish > -- David Arthur
