CQA 2.1: Release Notes Feb 26

[anarnold97]

Release Notes: CQA 2.1 & Vale Analysis Summary Report

---

• Release Notes CQA Feb 2026

---

Date: February 2025
Scope: docs/release-notes/, assemblies/release-notes/, topics/release-notes-topics/, and related attributes
Standards: CQA 2.1 (Content Quality Assessment), Vale linter with Red Hat and AsciiDocDITA packages only

---

1. Release Notes Master Assembly

File: docs/release-notes/master.adoc

Requirement	Action
Document ID	Added [id="release-notes"] before the level-0 heading.
Short description	Added [role="_abstract"] and a single paragraph (50–300 chars) after the title, with a blank line between title and short desc (CQA).
Assembly structure	Ensured only intro + include directives (no text between includes). Removed trailing :!release-notes: after the last include so no content follows includes.
Attribute order	Set :release-notes: near the top; kept :!release-notes: only before assembly includes so it does not appear after includes.

---

2. Topic and Reference Files

2.1 Hyphens (Red Hat)

• ref_fixed-issues-8-0-1.adoc – “open-source” → “open source” (multiple occurrences).

2.2 Case-sensitive terms (Red Hat)

• “VS Code” → “Visual Studio Code” in:
  • ref_new-features-and-enhancements-8-0.adoc
  • ref_removed-features-8-0.adoc
  • ref_fixed-issues-8-0-1.adoc
• “Lightspeed” / “Developer Lightspeed” → “Red Hat Developer Lightspeed” in:
  • ref_known-issues-8-0.adoc
  • ref_new-features-and-enhancements-8-0.adoc
  • ref_tech-previews-8-0.adoc

2.3 Other Red Hat style

• ref_known-issues-8-0.adoc – “Start/Stop” → “Start or Stop” (Slash rule); “using” → “by using” (Using rule).
• ref_new-features-and-enhancements-8-0.adoc, ref_removed-features-8-0.adoc – “plug-in” → “plugin”.
• ref_fixed-issues-8-0-1.adoc – “FQN” → “FQNs” where plural was intended; “Visual Studio (VS) Code” → “Visual Studio Code”.

2.4 Spelling (accepted terms)

• No wording changes; terms Agentic, containerless, decompiled, and FQNs were added to Red Hat Spelling filters so they are no longer flagged.

---

3. Attributes / Template File

File: topics/templates/document-attributes.adoc

• Set :_mod-docs-content-type: attributes at the top so AsciiDocDITA treats the file as an attributes/snippet-style file (no document title, id, or shortdesc required).
• GitLinks: The LinkAPI URL to https://github.com/windup/windup is now allowed via the GitLinks style change; no content change in the file.

---

4. Vale Run (final)

• Command (from repo root):
  vale docs/release-notes/master.adoc assemblies/release-notes/*.adoc topics/release-notes-topics/*.adoc topics/templates/document-attributes.adoc
• Result: No errors or warnings (exit code 0).
• Packages used: Red Hat and AsciiDocDITA only (from vale.ini; AsciiDocDITA from the official zip URL).

---

5. Files Modified

Path	Type of change
docs/release-notes/master.adoc	Structure, id, short desc, attribute placement
topics/templates/document-attributes.adoc	Content-type attribute
topics/release-notes-topics/ref_fixed-issues-8-0-1.adoc	Hyphens, VS Code, FQNs
topics/release-notes-topics/ref_fixed-issues-8-0.adoc	(Spelling only via filters)
topics/release-notes-topics/ref_known-issues-8-0.adoc	Lightspeed, Slash, Using
topics/release-notes-topics/ref_new-features-and-enhancements-8-0.adoc	VS Code, Lightspeed, plugin
topics/release-notes-topics/ref_removed-features-8-0.adoc	VS Code
topics/release-notes-topics/ref_tech-previews-8-0.adoc	Lightspeed

---

6. CQA 2.1 Alignment

• Vale: Only Red Hat and AsciiDocDITA packages used; Vale run is part of CQA.
• Assemblies: Intro (title + short desc) only, then include directives; no text between includes.
• Short descriptions: Single paragraph, 50–300 characters, [role="_abstract"], blank line after level-0 title.
• Document IDs: Level-0 heading has an assigned id where required.
• Pre-migration: Content passes the asciidoctor-dita-vale (AsciiDocDITA) check with no errors or warnings for the release-notes set.

[coderabbitai]

📝 Walkthrough

Walkthrough

This PR updates documentation for the 8.0.1 release, including updates to the release notes structure and index, consistent rebranding of "Developer Lightspeed" to "Red Hat Developer Lightspeed" across multiple release notes files, terminology standardization (VS Code, open source, FQNs), and minor formatting adjustments. A new document attribute metadata entry is also added.

Changes

Cohort / File(s)	Summary
Release Notes Structure docs/release-notes/master.adoc	Replaces 8.0.0 assembly reference with 8.0.1, updates document ID attribute structure, and adds introductory sentence for release notes content.
Release Notes Content – Naming & Terminology docs/topics/release-notes-topics/ref_fixed-issues-8-0-1.adoc, ref_known-issues-8-0.adoc, ref_new-features-and-enhancements-8-0.adoc, ref_tech-previews-8-0.adoc	Consistent rebranding of "Developer Lightspeed" to "Red Hat Developer Lightspeed", standardization of product terminology (VS Code extension, open source dependencies, FQNs), and minor grammatical adjustments for clarity and consistency.
Release Notes Content – Minor Updates docs/topics/release-notes-topics/ref_removed-features-8-0.adoc	Adds cross-reference link (MTA-5357) after XML rules section and adjusts formatting for Eclipse IDE plugin entry.
Documentation Metadata docs/topics/templates/document-attributes.adoc	Adds new document attribute _mod-docs-content-type: attributes for module content type metadata.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

Poem

🐰 Release notes hoppy and bright,
Lightspeed now wears Red Hat's light,
Docs restructured with version renewed,
Terminology tuned, consistency trued,
Documentation dreams take flight! ✨

🚥 Pre-merge checks | ✅ 2 | ❌ 1

❌ Failed checks (1 inconclusive)

Check name	Status	Explanation	Resolution
Title check	❓ Inconclusive	The title references a release cycle (CQA 2.1) and date but does not clearly describe the specific content changes made to the release notes documentation.	Consider a more descriptive title that explains the main changes, such as 'Update release notes for MTA 8.0.1 and product naming consistency' to better reflect the substantive updates across multiple documentation files.

✅ Passed checks (2 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment

---

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[coderabbitai]

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (1)

docs/topics/release-notes-topics/ref_known-issues-8-0.adoc (1)

46-51: ⚠️ Potential issue | 🟡 Minor

Use -- separator in the oc exec command (current en‑dash breaks the command).

Right now the command shows an en‑dash between deploy/kai-db and psql, which will fail when copied. Use the standard -- separator.

🔧 Proposed fix

-oc -n openshift-mta exec deploy/kai-db – psql -U postgres -d postgres -c "ALTER ROLE kai SET idle_session_timeout = '1min'; ALTER ROLE kai SET idle_in_transaction_session_timeout = '1min';" 
+oc -n openshift-mta exec deploy/kai-db -- psql -U postgres -d postgres -c "ALTER ROLE kai SET idle_session_timeout = '1min'; ALTER ROLE kai SET idle_in_transaction_session_timeout = '1min';"