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

Auto-generate documentation for topic-level configuration

    XMLWordPrintableJSON

Details

    • Bug
    • Status: Resolved
    • Major
    • Resolution: Fixed
    • None
    • 0.10.1.0
    • None
    • None

    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.

      Attachments

        1. configuration.html
          20 kB
          James Cheng
        2. topic_config.html
          5 kB
          James Cheng

        Issue Links

          Activity

            People

              wushujames James Cheng
              wushujames James Cheng
              Gwen Shapira Gwen Shapira
              Votes:
              0 Vote for this issue
              Watchers:
              4 Start watching this issue

              Dates

                Created:
                Updated:
                Resolved: