[ https://issues.apache.org/jira/browse/KAFKA-2967?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17244159#comment-17244159 ]
James Galasyn edited comment on KAFKA-2967 at 12/4/20, 5:37 PM: ---------------------------------------------------------------- [~tombentley] I'm not sure that we could generate links, but it seems at least plausible that we could. :D There's also the possibility of applying arbitrary CSS to the built pages, which mkdocs allows. We do a bit of that on the ksqlDB site in [extra.css|https://github.com/confluentinc/ksql/blob/master/docs/stylesheets/extra.css]. was (Author: jimgalasyn): [~tombentley] I'm not sure that could generate links, but it seems at least plausible that we could. :D There's also the possibility of applying arbitrary CSS to the built pages, which mkdocs allows. We do a bit of that on the ksqlDB site in [extra.css|https://github.com/confluentinc/ksql/blob/master/docs/stylesheets/extra.css]. > 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.3.4#803005)