[
https://issues.apache.org/jira/browse/KAFKA-2967?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17694156#comment-17694156
]
Jorge Esteban Quilcate Otoya commented on KAFKA-2967:
-----------------------------------------------------
Thanks [~mimaison]! Haven't tried it, but now that docs are in markdown it
should be straightforward to use something like pandoc to migrate them to
asciidoc.
I picked Markdown based on the latest comments that seem to agree using it, and
asciidoc interest sparked on 2018 without much follow up. Now that there is a
tool that support both may be worth revisiting this decision.
We already use markdown within the project for readmes and so, so adding
another markup would need to be weighed if it really adds value.
> 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)
