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

Move Kafka documentation to ReStructuredText

    XMLWordPrintableJSON

Details

    • Bug
    • Status: Open
    • Major
    • Resolution: Unresolved
    • None
    • None
    • 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

        Issue Links

          is superceded by

          Task - A task that needs to be done. KAFKA-14815 Move Kafka documentation to Markdown/Hugo

          • Major - Major loss of function.
          • Open

          Activity

            People

              gwenshap Gwen Shapira
              gwenshap Gwen Shapira
              Votes:
              2 Vote for this issue
              Watchers:
              21 Start watching this issue

              Dates

                Created:
                Updated: