[KAFKA-3809] Auto-generate documentation for topic-level configuration

• Type: Bug
• Status: Resolved
• Priority: Major
• Resolution: Fixed
• Fix Version/s: 0.10.1.0
• Assignee: James Cheng
• Reporter: James Cheng
• Reviewer: Gwen Shapira
• Created: 09/Jun/16 01:27
• Updated: 07/Aug/16 01:14
• Resolved: 07/Aug/16 01:14

Description

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.

Issue Links

• links to: GitHub Pull Request #1527