Gwen Shapira created KAFKA-2967:
-----------------------------------

             Summary: 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


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
(v6.3.4#6332)

Reply via email to