[
https://issues.apache.org/jira/browse/KAFKA-14815?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=18048291#comment-18048291
]
Harish Vishwanath edited comment on KAFKA-14815 at 12/29/25 9:26 PM:
---------------------------------------------------------------------
[Completed|https://github.com/apache/kafka-site] - Ref: [KIP
1133,|https://cwiki.apache.org/confluence/display/KAFKA/KIP-1133%3A+AK+Documentation+and+Website+in+Markdown#KIP1133:AKDocumentationandWebsiteinMarkdown-AKwebsitedocumentation]
[Automation|https://github.com/hvishwanath/ak2md]
was (Author: JIRAUSER308475):
Completed - Ref: [KIP
1133|https://cwiki.apache.org/confluence/display/KAFKA/KIP-1133%3A+AK+Documentation+and+Website+in+Markdown#KIP1133:AKDocumentationandWebsiteinMarkdown-AKwebsitedocumentation]
> Move Kafka documentation to Markdown/Hugo
> ------------------------------------------
>
> Key: KAFKA-14815
> URL: https://issues.apache.org/jira/browse/KAFKA-14815
> Project: Kafka
> Issue Type: Task
> Components: documentation
> Reporter: Jorge Esteban Quilcate Otoya
> Assignee: Harish Vishwanath
> Priority: Major
>
> 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:
> * Hugo requires Asciidoctor as additional binary (Markdown supported ootb)
> * To use Asciidoctor some security policies need to be opened:
> [https://stackoverflow.com/questions/71058236/hugo-with-asciidoctor]
> * I haven't managed to use shortcodes in Asciidoctor to inject versions,
> tables, etc.
> 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
--
This message was sent by Atlassian Jira
(v8.20.10#820010)
