[
https://issues.apache.org/jira/browse/KAFKA-2967?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=15184231#comment-15184231
]
Gwen Shapira commented on KAFKA-2967:
-------------------------------------
Thanks for the work [~ceposta]!
Is there any way to integrate the main site side-bar into the docs side-bar?
The one with downloads, FAQ, etc. This way the docs will feel like part of the
site, rather than a different experience.
2 + 3) Currently, the docs are maintained in the main JIRA and are partially
hard-coded HTML and partially generated HTML (all the configs are generated,
[~granthenke] is working on generating the protocol docs). When we package a
release, it combines the hard-coded HTML and the generated HTML into the
released HTML files and the release manager uploads the docs into a separate
docs repository.
> 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
>
> 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)
