kafka-jira mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "James Galasyn (Jira)" <j...@apache.org>
Subject [jira] [Commented] (KAFKA-2967) Move Kafka documentation to ReStructuredText
Date Thu, 03 Dec 2020 21:17:00 GMT

    [ https://issues.apache.org/jira/browse/KAFKA-2967?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17243518#comment-17243518
] 

James Galasyn commented on KAFKA-2967:
--------------------------------------

Thank you for the feedback, [~vvcephei]! I only suggested RTD because that's what we do for
ksqlDB, but I'm very happy to use the existing infra. I think you're right about leveraging
the existing job, but I don't know the deets. Maybe [~guozhang] or [~mjsax] can weigh in.

So it seems like it's not a huge lift to make this happen. If everybody thinks it's worthwhile
for me to investigate, I'd like to dive in for a couple of days and see what I come up with.

> 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)

Mime
View raw message