kafka-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "ASF GitHub Bot (JIRA)" <j...@apache.org>
Subject [jira] [Commented] (KAFKA-3809) Auto-generate documentation for topic-level configuration
Date Fri, 05 Aug 2016 23:54:20 GMT

    [ https://issues.apache.org/jira/browse/KAFKA-3809?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=15410292#comment-15410292
] 

ASF GitHub Bot commented on KAFKA-3809:
---------------------------------------

Github user wushujames closed the pull request at:

    https://github.com/apache/kafka/pull/1527


> 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)

Mime
View raw message