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

Include human readable quantities for default config docs

    XMLWordPrintableJSON

    Details

    • Type: Improvement
    • Status: Resolved
    • Priority: Trivial
    • Resolution: Fixed
    • Affects Version/s: None
    • Fix Version/s: 2.6.0
    • Component/s: docs
    • Labels:
      None

      Description

      The Kafka config docs include default values for quantities in milliseconds and bytes, for example log.segment.bytes has default: 1073741824. Many readers won't know that that's 1GiB, so will have to work it out. It would make the docs more readable if we included the quantity in the appropriate unit in parenthesis after the actual default value, like this:

      default: 1073741824 (=1GiB)

      Similarly for values in milliseconds.

        Attachments

          Issue Links

            Activity

              People

              • Assignee:
                tombentley Tom Bentley
                Reporter:
                tombentley Tom Bentley
              • Votes:
                0 Vote for this issue
                Watchers:
                2 Start watching this issue

                Dates

                • Created:
                  Updated:
                  Resolved: