rh-ssg-release-notes

To check SSG compliance for Red Hat release notes, review them against the Supplementary Style Guide rules for tense consistency, informative headings, Jira ticket references, and AsciiDoc formatting. This verifies clarity, user impact, and specific content type guidelines like new features and fixed issues.

Automating release notes review involves processing the document to validate AsciiDoc formatting and verify tense consistency against the Supplementary Style Guide. This process flags deviations as required or suggested improvements, ensuring technical accuracy and adherence to specific content type rules.

Yes, SSG compliance checks validate Jira ticket references in release notes. The review process specifically scans for missing Jira references and flags them as deviations, ensuring that all technical issues, enhancements, and fixed issues are properly tracked according to Red Hat guidelines.

To audit release notes for content types like deprecated features and technology previews, validate the document against the Supplementary Style Guide. This checks adherence to specific rules for each content category, ensuring appropriate user impact descriptions and technical accuracy for rebases and enhancements.

Red Hat release notes must maintain tense consistency to pass SSG compliance. The review process checks for deviations from the Supplementary Style Guide standards, flagging any inconsistent tense usage as a required or suggested improvement before the document is published.

AsciiDoc formatting is flagged as a required improvement because SSG compliance mandates strict formatting rules. The review process identifies deviations from these Supplementary Style Guide standards, categorizing formatting errors and missing Jira references to improve clarity and consistency across documentation.