[ https://issues.apache.org/jira/browse/KAFKA-3809?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=15323967#comment-15323967 ]
James Cheng commented on KAFKA-3809: ------------------------------------ [~jjkoshy], would you be open to splitting https://issues.apache.org/jira/browse/KAFKA-3234 into the following pieces? 1) auto-generation of the documentation for topic-level configs 2) design documentation updates 3) the renaming and deprecation of the existing topic-level configurations The 3rd one would presumably require a KIP and discussion, whereas 1) and 2) are pretty straight-foward. What do you think? If you are okay with the approach, would you be okay if I took over the work of auto-generating the topic-level docs? I can base it on the pull request that you already did for https://issues.apache.org/jira/browse/KAFKA-3234. > Auto-generate documentation for topic-level configuration > --------------------------------------------------------- > > Key: KAFKA-3809 > URL: https://issues.apache.org/jira/browse/KAFKA-3809 > Project: Kafka > Issue Type: Bug > Reporter: James Cheng > Assignee: James Cheng > Attachments: configuration.html, topic_config.html > > > The documentation for topic-level configuration is not auto-generated from > the code. configuration.html still contains hand-maintained documentation. > I noticed this because I wanted to set message.timestamp.type on a topic, and > didn't see that it was supported, but grepped through the code and it looked > like it was. > The code to auto-generate the docs is quite close, but needs some additional > work. In particular, topic-level configuration is different from all the > other ConfigDefs in that topic-level configuration docs list the broker-level > config that they inherit from. We would need to have a way to show what > broker-level config applies to each topic-level config. -- This message was sent by Atlassian JIRA (v6.3.4#6332)