Uploaded image for project: 'Quarkus'
  1. Quarkus
  2. QUARKUS-2040

Review and enhance our H3 & H4 headings in release notes

XMLWordPrintable

      User story:

      As a Quarkus developer, I would like to be able to easily find what I need in the release notes. I'd prefer not to have to scroll down through long unordered lists of enhancements, known issues, fixes, and backward compatibility issues. Help me to find what I need and make the release notes easier to navigate through with meaningful and accurate sub-categories to group long lists of items. 

      Scope:s con

      In 2.7 Elektra, we introduced some categories to help improve findability in the 'Enhancements' section. This Jira continues that effort, with the following potential sub-tasks:

      • Review impact and progress of existing categories.
      • Discuss and research community doc categories - potential alignment.
      • Discuss adding an aligned category approach to other sections that have potentially long lists of items in the release notes, for example, 1.6. Changes that affect backwards compatibility.
      • Define and document the process for writers to use to develop and categorize content in the release notes for alignment, usability, and compatibility with community docs. Involve and seek support from SMEs in this process.
      • Continue the effort that was started in Elektra task #QUARKUS-2039 to ensure that our headings are compliant with RH style,  consistent (parallel), and in a logical or alphabetical order. Also, ensure that we have guidelines for adding H4 items according to the agreed order as per the style guide.

      Note: The restructure of H1and H2 are outside the scope of this JIRA.

              mpurcell@redhat.com Michelle Purcell
              mpurcell@redhat.com Michelle Purcell
              Pablo Gonzalez Granados Pablo Gonzalez Granados (Inactive)
              Votes:
              0 Vote for this issue
              Watchers:
              5 Start watching this issue

                Created:
                Updated:
                Resolved: