Uploaded image for project: 'Quarkus Documentation'
  1. Quarkus Documentation
  2. QDOCS-1483

Better New Features release note descriptions - Release Notes

XMLWordPrintable

    • 8
    • False
    • Hide

      None

      Show
      None
    • False

      According to the first IBM release retrospective document, a request to improve the source of truth for the New Features description was raised.

      As such, we would like to establish a process in which developers add a Release Note text description as a requirement for their Done status in JIRA, or simply create a few-sentence-long description based on a provided template that could be reused over several places.

      The aim is not to require only product-specific text, but a text that could be used on all fronts (Quarkus/RHBQ-IBMQB Release Notes).

      This requires decisions in three areas:
      1) Decide where the content lives and what use cases it targets.
      2) Decide the format and writing rules, including examples that developers can reuse in their own texts.
      3) Decide how to automate single-sourcing from upstream, including the integration workflow and ownership.

      Coordinate with Guillaume to confirm feasibility and to define an implementation plan.

      Hint from Paul Robinson: We could populate the release announcement blog with these mentions.
      Hint from Thomas Q.: Maybe not all new features need this text description; only those that are for an Upstream/Downstream RN

              mmaler@redhat.com Michal Maléř
              mmaler@redhat.com Michal Maléř
              Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

                Created:
                Updated: