[RHIDP#12789]: Fix CQA PR comment rendering issues

[themr0c]

IMPORTANT: Do Not Merge - To be merged by Docs Team Only

Version(s): N/A (tooling only)
Issue: https://redhat.atlassian.net/browse/RHIDP-12789
Preview: N/A

Summary

Fixes two rendering issues in the CQA GitHub Actions PR comment:

• Code block wrapping: The cqa.sh output contained triple-backtick fenced code blocks for the "To auto-fix" and "To fix" instructions, causing GitHub to render the entire checklist as a plain code block instead of formatted markdown with checkboxes. Replaced with inline code.
• Auto-linked issue numbers: CQA #N notation (e.g., CQA #0, CQA #3) caused GitHub to auto-link #N to unrelated issues/PRs. Replaced with CQA-N across all 43 affected files (scripts, Claude skills, docs).

[rhdh-bot]

Updated preview: https://redhat-developer.github.io/red-hat-developers-documentation-rhdh/pr-1952/ @ 03/20/26 15:35:14

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

[rhdh-bot]

Content Quality Assessment Results

CQA Summary Checklist

• CQA #0: Find Orphaned Modules and Images
• CQA #0: Verify Directory Structure (_ naming)
• CQA RHIDP-208 Add missing images #3: Verify Content Type Metadata
• CQA RHIDP-208-1 Add plugins support matrix #13: Verify Content Matches Declared Type
• CQA RHIDP-449-1 Support for dark theme in RHDH #10: Verify Titles Are Brief, Complete, and Descriptive
• CQA Rhidp 449 Customize theme mode #8: Verify Short Description Content Quality
• CQA #9: Verify Short Description Format
• CQA RHIDP-449-2 Update attributes file symbolic link #11: Verify Procedure Prerequisites
• CQA RHIDP-208 Update attributes file #2: Verify Assembly Structure
• CQA RHIDP-208 Title structure tidy-up #5: Verify Required Modular Elements
  • [MANUAL] modules/shared/proc-mirror-plugins-from-a-catalog-index-to-a-partially-disconnected-environment.adoc: Non-standard block title: .Example
  • [MANUAL] modules/shared/proc-mirror-plugins-from-a-catalog-index-to-a-fully-disconnected-environment.adoc: Non-standard block title: .Example
  • [MANUAL] modules/shared/proc-mirror-plugins-from-a-catalog-index-to-a-fully-disconnected-environment.adoc: Non-standard block title: .Example
  • [MANUAL] modules/shared/proc-mirror-specific-plugins-by-direct-reference.adoc: Non-standard block title: .Example
  • [MANUAL] modules/shared/proc-mirror-plugins-from-a-file.adoc: Non-standard block title: .Example
  • [MANUAL] modules/shared/proc-combine-many-plugin-sources.adoc: Non-standard block title: .Example
  • [-> CQA RHIDP-208 Update attributes file #2 MANUAL] assemblies/extend_installing-and-viewing-plugins-in-rhdh/assembly-install-plugins-from-oci-registries-by-using-custom-certificates.adoc: Assembly contains block titles (only .Additional resources allowed)
  • [MANUAL] modules/shared/proc-export-plugins-in-rhdh.adoc: Non-standard block title: .Example dynamic plugin export with shared and embedded packages
  • [MANUAL] modules/shared/proc-export-plugins-in-rhdh.adoc: Non-standard block title: .Example command to log the default configuration
  • [MANUAL] modules/shared/proc-export-plugins-in-rhdh.adoc: Non-standard block title: .Default scalprum configuration
  • [MANUAL] modules/shared/proc-export-plugins-in-rhdh.adoc: Non-standard block title: .Example scalprum customization
  • [MANUAL] modules/shared/proc-export-plugins-in-rhdh.adoc: Non-standard block title: .Example static and dynamic plugin export
  • [MANUAL] modules/shared/proc-create-a-tgz-file-with-dynamic-packages.adoc: Non-standard block title: .Example commands to build and deploy an HTTP server in {ocp-short}
  • [MANUAL] modules/shared/proc-load-a-plugin-packaged-as-a-javascript-package.adoc: Non-standard block title: .Example secret configuration
  • [MANUAL] modules/shared/proc-example-of-installing-a-custom-plugin-in-rhdh.adoc: Line 16: Image(s) missing alt text in quotes
  • [MANUAL] modules/shared/proc-example-of-installing-a-custom-plugin-in-rhdh.adoc: Non-standard block title: .Container images published to Quay.io
  • [MANUAL] modules/shared/proc-display-the-front-end-plugin.adoc: Line 61: Image(s) missing alt text in quotes
  • [MANUAL] modules/shared/proc-view-available-plugins.adoc: Line 14: Image(s) missing alt text in quotes
  • [MANUAL] modules/shared/proc-search-for-plugins-by-name.adoc: Line 12: Image(s) missing alt text in quotes
  • [MANUAL] modules/shared/proc-manage-plugins-by-using-extensions.adoc: Line 16: Image(s) missing alt text in quotes
  • [MANUAL] modules/shared/proc-configure-rbac-to-manage-extensions.adoc: Line 23: Image(s) missing alt text in quotes
  • [MANUAL] modules/shared/proc-configure-rhdh-local-to-install-plugins-by-using-extensions.adoc: Has 2 H1 titles (should be exactly 1)
  • [MANUAL] modules/shared/proc-install-plugins-by-using-extensions.adoc: Line 18: Image(s) missing alt text in quotes
  • [MANUAL] modules/shared/proc-enable-and-disable-plugins-by-using-extensions.adoc: Line 18: Image(s) missing alt text in quotes
  • [MANUAL] modules/shared/ref-customizing-entity-page.adoc: Line 11: Non-standard block title: .Input parameters
  • [MANUAL] modules/shared/ref-customizing-and-extending-entity-tabs.adoc: Line 43: Non-standard block title: .Input parameters
  • [MANUAL] modules/extend_orchestrator-in-rhdh/ref-compatibility-guide-for-orchestrator.adoc: Line 14: Non-standard block title: .Compatible Orchestrator and infrastructure versions
  • [MANUAL] modules/extend_orchestrator-in-rhdh/proc-enable-the-orchestrator-plugins-using-the-operator.adoc: Non-standard block title: .Example: Complete configuration of the Orchestrator plugin
  • [MANUAL] modules/extend_orchestrator-in-rhdh/proc-integrate-loki-logs-for-orchestrator-workflows.adoc: Line 21: Image(s) missing alt text in quotes
  • [MANUAL] modules/extend_orchestrator-in-rhdh/proc-create-a-serverless-workflow-project.adoc: Line 36: Image(s) missing alt text in quotes
  • [MANUAL] modules/extend_orchestrator-in-rhdh/proc-verify-the-deployment.adoc: Line 26: Image(s) missing alt text in quotes
  • [MANUAL] modules/shared/proc-use-the-argo-cd-plugin.adoc: Line 19: Image(s) missing alt text in quotes
  • [MANUAL] modules/shared/proc-use-the-jfrog-artifactory-plugin.adoc: Line 23: Image(s) missing alt text in quotes
  • [MANUAL] modules/shared/proc-use-the-nexus-repository-manager-plugin.adoc: Line 21: Image(s) missing alt text in quotes
  • [MANUAL] modules/shared/proc-use-the-tekton-plugin.adoc: Line 21: Image(s) missing alt text in quotes
  • [MANUAL] modules/shared/proc-use-the-topology-plugin.adoc: Line 20: Image(s) missing alt text in quotes
  • [MANUAL] modules/integrate_interacting-with-model-context-protocol-tools-for-rhdh/ref-accessing-rhdh-data-using-the-software-catalog-mcp-tools.adoc: Line 15: Non-standard block title: .Available tools in the software-catalog-mcp-tool plugin
  • [MANUAL] modules/integrate_interacting-with-model-context-protocol-tools-for-rhdh/ref-fetching-entities-using-fetch-catalog-entities.adoc: Line 16: Non-standard block title: .Parameters for the fetch-catalog-entities tool
  • [MANUAL] modules/integrate_interacting-with-model-context-protocol-tools-for-rhdh/ref-unregistering-entities-using-catalog-unregister-tool.adoc: Line 11: Non-standard block title: .Parameters for catalog-unregister-tool
  • [MANUAL] modules/integrate_interacting-with-model-context-protocol-tools-for-rhdh/ref-retrieving-software-template-metadata.adoc: Line 11: Non-standard block title: .Parameters for software-template-metadata-tool
  • [MANUAL] modules/integrate_interacting-with-model-context-protocol-tools-for-rhdh/ref-accessing-and-analyzing-documentation-using-the-techdocs-mcp-tools.adoc: Line 11: Non-standard block title: .TechDocs tools and parameters
  • [MANUAL] modules/integrate_interacting-with-model-context-protocol-tools-for-rhdh/ref-measuring-documentation-gaps-using-analyze-techdocs-coverage.adoc: Line 24: Non-standard block title: .Parameters for the analyze-techdocs-coverage TechDocs MCP tool
  • [MANUAL] modules/observability_audit-logs-in-rhdh/proc-forward-rhdh-audit-logs-to-splunk.adoc: Non-standard block title: .Example pipelines configuration
  • [MANUAL] modules/observability_audit-logs-in-rhdh/proc-forward-rhdh-audit-logs-to-splunk.adoc: Non-standard block title: .Example command to apply ClusterLogForwarder configuration
  • [MANUAL] modules/observability_audit-logs-in-rhdh/proc-forward-rhdh-audit-logs-to-splunk.adoc: Non-standard block title: .Example collector configuration
  • [MANUAL] modules/observability_audit-logs-in-rhdh/proc-forward-rhdh-audit-logs-to-splunk.adoc: Non-standard block title: .Example tuning configuration
  • [MANUAL] modules/observability_telemetry-data-collection-and-analysis/proc-disable-telemetry-data-collection-using-the-helm-chart.adoc: Line 36: Image(s) missing alt text in quotes
  • [MANUAL] modules/observability_telemetry-data-collection-and-analysis/proc-customize-segment-source-using-the-helm-chart.adoc: Line 25: Image(s) missing alt text in quotes
• CQA RHIDP-208 Add missing images #4: Verify Module Templates
• CQA RHIDP-131: Installing RHDH document #6: Verify Assemblies Follow Official Template (One User Story)
  • [MANUAL] assemblies/extend_installing-and-viewing-plugins-in-rhdh/assembly-front-end-plugin-wiring.adoc: Has 20 includes (consider splitting -- may cover multiple user stories, max 15)
• CQA dummy commit to test asciidoctor gen for PRs #7: Verify TOC Depth (Max 3 Levels)
• CQA Remove tracked build files #16: Verify Official Product Names
• CQA RHIDP-452 Add attributes configuration and conscious language statement to Release Notes. #1: Vale AsciiDoc DITA Compliance
• CQA RHIDP-449-2 Add theme mode content #12: Verify Grammar and Style (Vale)
• CQA RHIDP-208-2 Red Hat Developer Hub Administration Guide - initial commit #17: Verify Legal Disclaimers for Preview Features
  • [MANUAL] modules/extend_dynamic-plugins-reference/ref-other-installable-plugins.adoc: Line 7: Mentions 'Technology Preview' but may not include official disclaimer snippet
  • [MANUAL] modules/shared/proc-navigate-the-plugin-marketplace-and-filter-plugins-using-badges.adoc: Line 20: Mentions 'Developer Preview' but may not include official disclaimer snippet
  • [MANUAL] modules/integrate_accelerating-ai-development-with-openshift-ai-connector-for-rhdh/proc-set-up-with.adoc: Line 282: Mentions 'Developer Preview' but may not include official disclaimer snippet
  • [MANUAL] modules/shared/con-about-and-llama-stack.adoc: Line 38: Mentions 'Developer Preview' but may not include official disclaimer snippet
  • [MANUAL] modules/shared/proc-install-and-configure.adoc: Line 17: Mentions 'Developer Preview' but may not include official disclaimer snippet
  • [MANUAL] modules/observability_adoption-insights-in-rhdh/proc-enable-the-adoption-insights-plugin.adoc: Line 7: Mentions 'Developer Preview' but may not include official disclaimer snippet
• CQA RHIDP-208 Added dynamic plugin installation content #14: Verify No Broken Links
• CQA RHIDP-442: RBAC feature documentation  #15: Check Redirects

---

Total: 19 checks | 16 passed | 3 with issues

To auto-fix what can be auto-fixed, run:

./build/scripts/cqa.sh --fix --all

To fix remaining issues, copy-paste this prompt to Claude:

Run ./build/scripts/cqa.sh --all, then for each failing CQA check, read the matching .claude/skills/cqa-*.md skill file and fix the [MANUAL] issues following the skill instructions.

---

Automated CQA check run on the entire repository