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

Move Kafka documentation to Markdown/Hugo

    XMLWordPrintableJSON

Details

    • Task
    • Status: Open
    • Major
    • Resolution: Unresolved
    • None
    • None
    • documentation
    • None

    Description

      Follow up from https://issues.apache.org/jira/browse/KAFKA-2967

      Creating this task to discuss the adoption of Markdown and Hugo, and replace the HTML code.

      The reasons to move away from HTML are outlined in KAFKA-2967.

      Markdown and Asciidoc are both alternatives, but Markdown has been used, as I found some blockers when trying to migrate to Asciidoc:

      Given the lower friction of Markdown and default support from Hugo, I would like to propose using these. Though I'm open to collaborate if someone has experience with Asciidoc and Hugo to make the migration as there is an existing interest to use Asciidoc if possible.

      Draft repo: https://github.com/jeqo/ak-docs

      Attachments

        Issue Links

          Activity

            People

              Unassigned Unassigned
              jeqo Jorge Esteban Quilcate Otoya
              Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

              Dates

                Created:
                Updated: