[ https://issues.apache.org/jira/browse/KAFKA-2967?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17693955#comment-17693955 ]
Mickael Maison commented on KAFKA-2967: --------------------------------------- Thanks [~jeqo] for picking this up, your PoC looks really good! >From the discussion above, it seems there was consensus on using asciidoc if >possible. It looks like this may be possible with Hugo: >https://gohugo.io/content-management/formats/#list-of-content-formats Have you >tried it? > Move Kafka documentation to ReStructuredText > -------------------------------------------- > > Key: KAFKA-2967 > URL: https://issues.apache.org/jira/browse/KAFKA-2967 > Project: Kafka > Issue Type: Bug > Reporter: Gwen Shapira > Assignee: Gwen Shapira > Priority: Major > Labels: documentation > > Storing documentation as HTML is kind of BS :) > * Formatting is a pain, and making it look good is even worse > * Its just HTML, can't generate PDFs > * Reading and editting is painful > * Validating changes is hard because our formatting relies on all kinds of > Apache Server features. > I suggest: > * Move to RST > * Generate HTML and PDF during build using Sphinx plugin for Gradle. > Lots of Apache projects are doing this. -- This message was sent by Atlassian Jira (v8.20.10#820010)