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

[Docs] Enhance release note sub-headings in chapters 3 and 7

XMLWordPrintable

    • Icon: Task Task
    • Resolution: Done
    • Icon: Major Major
    • 3.2.6-Ghost.GA
    • None
    • team/docs
    • None
    • 2
    • -
    • ---

      PV2 preview on main project:

       

      https://pantheon.corp.redhat.com/pantheon/preview/latest/a27c9c4d-e058-42f4-bf46-6a1e489cfb90?rerender=true#ref_rn-new-features-changes-and-technical-enhancements_quarkus-release-notes

       

      This JIRA tracks the post-release follow-up action items that were identified during the final release note review towards the end of the Fireball release that need SME or QE input in the new features section, which has lots of different writers contributing to.

      • Some headings are over 12 words long. (The recommendation for SEO optimization plus both our upstream and downstream CCS style guidelines are between 3-8).
      • Need a consistent approach to heading construction. Some start with " Support for xyz". Some end with "XYZ supported", same for introduced/new/added.
      • Some headings lead with Red Hat build of Quarkus, some lead with the short product name.  The title should ideally lead with the strongest technical key word rather than a product name, given that all items are about the product name, so the product name in the title reduces becomes redundant and also reduces findability and increases wordiness.

            mpurcell@redhat.com Michelle Purcell
            mpurcell@redhat.com Michelle Purcell
            Votes:
            0 Vote for this issue
            Watchers:
            6 Start watching this issue

              Created:
              Updated:
              Resolved: