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

Add references to important installation/upgrade notes to release notes

    XMLWordPrintableJSON

    Details

    • Type: Bug
    • Status: Resolved
    • Priority: Blocker
    • Resolution: Fixed
    • Affects Version/s: 0.10.0.0
    • Fix Version/s: 0.10.0.1
    • Component/s: None
    • Labels:
      None

      Description

      Today we use the release notes exactly as exported from JIRA (see "Prepare release notes" on https://cwiki.apache.org/confluence/display/KAFKA/Release+Process) and then rely on users to dig through our documentation (none of which starts with release-specific notes) to upgrade and installation notes.

      Especially for folks who aren't intimately familiar with our docs, the information is very easy to miss. Ideally we could automate the release notes process a bit and then have them automatically modified to at least include links at the very top (it'd be nice if we had some other header material added as well since the automatically generated release notes are very barebones...). Even better would be if we could pull in the version-specific installation/upgrade notes directly.

        Attachments

          Issue Links

            Activity

              People

              • Assignee:
                ewencp Ewen Cheslack-Postava
                Reporter:
                ewencp Ewen Cheslack-Postava
              • Votes:
                0 Vote for this issue
                Watchers:
                3 Start watching this issue

                Dates

                • Created:
                  Updated:
                  Resolved: