Uploaded image for project: 'Kafka'
  1. Kafka
  2. KAFKA-2967

Move Kafka documentation to ReStructuredText

    Details

    • Type: Bug
    • Status: Open
    • Priority: Major
    • Resolution: Unresolved
    • Affects Version/s: None
    • Fix Version/s: None
    • Component/s: None
    • Labels:
      None

      Description

      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.

        Attachments

          Activity

            People

            • Assignee:
              gwenshap Gwen Shapira
              Reporter:
              gwenshap Gwen Shapira
            • Votes:
              1 Vote for this issue
              Watchers:
              14 Start watching this issue

              Dates

              • Created:
                Updated: