Skip to content

RHIDP-6585: Update ArgoCD plugin docs to include notification capabilities#1774

Open
jmagak wants to merge 12 commits intoredhat-developer:mainfrom
jmagak:RHIDP-6585-Update-ArgoCD-plugin-docs-to-include-notification-capabilities
Open

RHIDP-6585: Update ArgoCD plugin docs to include notification capabilities#1774
jmagak wants to merge 12 commits intoredhat-developer:mainfrom
jmagak:RHIDP-6585-Update-ArgoCD-plugin-docs-to-include-notification-capabilities

Conversation

@jmagak
Copy link
Copy Markdown
Member

@jmagak jmagak commented Feb 9, 2026

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

Version(s): 1.9, main

Issue: RHIDP-6585

Preview:

additional-rhdh-capabilities

@rhdh-bot
Copy link
Copy Markdown
Collaborator

rhdh-bot commented Feb 9, 2026

@jmagak jmagak force-pushed the RHIDP-6585-Update-ArgoCD-plugin-docs-to-include-notification-capabilities branch from dad7712 to 59ef2df Compare February 9, 2026 21:06
@jmagak jmagak force-pushed the RHIDP-6585-Update-ArgoCD-plugin-docs-to-include-notification-capabilities branch from 59ef2df to 74fbd9b Compare February 10, 2026 08:19
Copy link
Copy Markdown
Member

@hmanwani-rh hmanwani-rh left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@jmagak I’ve added some suggestions for the title, subtitle, and abstract. Please take a look when you get a chance and let me know if they look good to you.

I’ve also drafted a disclaimer and shared it with Emily for review. Once it’s approved, I’ll pass it along so we can incorporate it as well.

@jmagak jmagak force-pushed the RHIDP-6585-Update-ArgoCD-plugin-docs-to-include-notification-capabilities branch from 45df61b to 2df26cd Compare February 10, 2026 15:21
@jmagak
Copy link
Copy Markdown
Member Author

jmagak commented Feb 10, 2026

@jmagak I’ve added some suggestions for the title, subtitle, and abstract. Please take a look when you get a chance and let me know if they look good to you.

I’ve also drafted a disclaimer and shared it with Emily for review. Once it’s approved, I’ll pass it along so we can incorporate it as well.

Thank you so much, Heena for these great suggestions and generally for the huge work with this.

@jmagak jmagak force-pushed the RHIDP-6585-Update-ArgoCD-plugin-docs-to-include-notification-capabilities branch from 8f0c499 to 9896864 Compare February 11, 2026 09:47
@jmagak jmagak force-pushed the RHIDP-6585-Update-ArgoCD-plugin-docs-to-include-notification-capabilities branch from 9896864 to 761b0c2 Compare February 11, 2026 10:36
@jmagak jmagak force-pushed the RHIDP-6585-Update-ArgoCD-plugin-docs-to-include-notification-capabilities branch from 761b0c2 to aa8ed2f Compare February 16, 2026 22:11
@jmagak jmagak requested a review from djanickova February 17, 2026 11:35
@jmagak jmagak force-pushed the RHIDP-6585-Update-ArgoCD-plugin-docs-to-include-notification-capabilities branch from aa8ed2f to 8f0c499 Compare February 17, 2026 12:54
Copy link
Copy Markdown
Member

@djanickova djanickova left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Regarding the feedback from test day, to provide additional clarification:
Parts 1.1–1.4 are performed inside the RHDH application (source repo / image build), so changes to the RHDH instance itself.
Parts 2–3 (ArgoCD configuration and Application annotations) are cluster-level steps executed via oc and apply directly to the OpenShift environment hosting ArgoCD.

Possibly we could add a short section to the beginning about what will need to be updated and where - maybe a short list of the steps needed to be done and where they will be executed? However, this documentation is very much aimed at platform engineers (who will probably understand this even from the diagram), not just regular developers, as changes in the cluster need to be done to make this feature work. It would maybe be worth pointing this out in the beginning of the tutorial as well, just so that readers understand that this is quite a technical topic and not something that can be configured by anyone.

@jmagak jmagak force-pushed the RHIDP-6585-Update-ArgoCD-plugin-docs-to-include-notification-capabilities branch from 535eb81 to 2852506 Compare February 17, 2026 15:38
@rhdh-bot
Copy link
Copy Markdown
Collaborator

rhdh-bot commented Mar 20, 2026

@jmagak jmagak force-pushed the RHIDP-6585-Update-ArgoCD-plugin-docs-to-include-notification-capabilities branch from 9e09499 to 9e55dc3 Compare March 23, 2026 12:59
@rhdh-bot
Copy link
Copy Markdown
Collaborator

Content Quality Assessment Results

CQA Summary Checklist

  • CQA-0: Find orphaned modules and images
  • CQA-0: Verify directory structure (_ naming)
    • [MANUAL] titles/additional-rhdh-capabilities/master.adoc: Missing :_mod-docs-category: attribute
  • CQA-3: Verify content type metadata
    • [AUTOFIX] titles/additional-rhdh-capabilities/master.adoc: Line 1: Content type: -> ASSEMBLY
  • CQA-13: Verify content matches declared type
  • CQA-10: Verify titles are brief, complete, and descriptive
  • CQA-8: Verify short description content quality
  • CQA-9: Verify short description format
  • CQA-11: Verify procedure prerequisites
  • CQA-2: Verify assembly structure
    • [AUTOFIX] titles/additional-rhdh-capabilities/master.adoc: Line 1: Content type ASSEMBLY not on first line
    • [-> CQA-9 AUTOFIX] titles/additional-rhdh-capabilities/master.adoc: Missing [role="_abstract"] introduction
  • CQA-5: Verify required modular elements
    • [-> CQA-3 AUTOFIX] titles/additional-rhdh-capabilities/master.adoc: Missing :_mod-docs-content-type: metadata
    • [-> CQA-2 AUTOFIX] titles/additional-rhdh-capabilities/master.adoc: Missing or incorrect topic ID (master.adoc should use [id="{context}"])
    • [-> CQA-9 AUTOFIX] titles/additional-rhdh-capabilities/master.adoc: Missing [role="_abstract"] short introduction
    • [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-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-4: Verify module templates
  • CQA-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-7: Verify TOC depth (max 3 levels)
  • CQA-16: Verify official product names
    • [AUTOFIX] titles/additional-rhdh-capabilities/additional-capabilities/additional-rhdh-capabilities.adoc: Line 417: Hardcoded "Backstage" -> {backstage} or {product-custom-resource-type}
    • [AUTOFIX] titles/additional-rhdh-capabilities/additional-capabilities/additional-rhdh-capabilities.adoc: Line 506: Hardcoded "Backstage" -> {backstage} or {product-custom-resource-type}
    • [AUTOFIX] titles/additional-rhdh-capabilities/additional-capabilities/additional-rhdh-capabilities.adoc: Line 507: Hardcoded "Backstage" -> {backstage} or {product-custom-resource-type}
    • [AUTOFIX] titles/additional-rhdh-capabilities/additional-capabilities/additional-rhdh-capabilities.adoc: Line 607: Hardcoded "Backstage" -> {backstage} or {product-custom-resource-type}
    • [AUTOFIX] titles/additional-rhdh-capabilities/additional-capabilities/additional-rhdh-capabilities.adoc: Line 621: Hardcoded "Backstage" -> {backstage} or {product-custom-resource-type}
    • [AUTOFIX] titles/additional-rhdh-capabilities/additional-capabilities/additional-rhdh-capabilities.adoc: Line 622: Hardcoded "Backstage" -> {backstage} or {product-custom-resource-type}
    • [AUTOFIX] titles/additional-rhdh-capabilities/additional-capabilities/additional-rhdh-capabilities.adoc: Line 630: Hardcoded "Backstage" -> {backstage} or {product-custom-resource-type}
  • CQA-1: Vale AsciiDoc DITA compliance
  • CQA-12: Verify grammar and style (Vale)
  • CQA-17: Verify legal disclaimers for preview features
    • [MANUAL] titles/additional-rhdh-capabilities/master.adoc: Line 5: Mentions 'Developer Preview' but may not include official disclaimer snippet
    • [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-14: Verify no broken links
  • CQA-15: Check redirects

Total: 19 checks | 12 passed | 7 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

@jmagak jmagak force-pushed the RHIDP-6585-Update-ArgoCD-plugin-docs-to-include-notification-capabilities branch from 9e55dc3 to 7eaa215 Compare March 30, 2026 10:52
@jmagak jmagak force-pushed the RHIDP-6585-Update-ArgoCD-plugin-docs-to-include-notification-capabilities branch from e71b49f to 619b22e Compare March 30, 2026 11:39
@rhdh-bot
Copy link
Copy Markdown
Collaborator

Content Quality Assessment Results

CQA Summary Checklist

  • CQA-0: Find orphaned modules and images
  • CQA-0: Verify directory structure (_ naming)
    • [MANUAL] titles/additional-rhdh-capabilities/master.adoc: Missing :_mod-docs-category: attribute
  • CQA-3: Verify content type metadata
    • [AUTOFIX] titles/additional-rhdh-capabilities/master.adoc: Line 1: Content type: -> ASSEMBLY
  • CQA-13: Verify content matches declared type
  • CQA-10: Verify titles are brief, complete, and descriptive
  • CQA-8: Verify short description content quality
  • CQA-9: Verify short description format
  • CQA-11: Verify procedure prerequisites
  • CQA-2: Verify assembly structure
    • [AUTOFIX] titles/additional-rhdh-capabilities/master.adoc: Line 1: Content type ASSEMBLY not on first line
    • [-> CQA-9 AUTOFIX] titles/additional-rhdh-capabilities/master.adoc: Missing [role="_abstract"] introduction
  • CQA-5: Verify required modular elements
    • [-> CQA-3 AUTOFIX] titles/additional-rhdh-capabilities/master.adoc: Missing :_mod-docs-content-type: metadata
    • [-> CQA-2 AUTOFIX] titles/additional-rhdh-capabilities/master.adoc: Missing or incorrect topic ID (master.adoc should use [id="{context}"])
    • [-> CQA-9 AUTOFIX] titles/additional-rhdh-capabilities/master.adoc: Missing [role="_abstract"] short introduction
  • CQA-4: Verify module templates
  • CQA-6: Verify assemblies follow official template (one user story)
  • CQA-7: Verify TOC depth (max 3 levels)
  • CQA-16: Verify official product names
    • [AUTOFIX] titles/additional-rhdh-capabilities/additional-capabilities/additional-rhdh-capabilities.adoc: Line 417: Hardcoded "Backstage" -> {backstage} or {product-custom-resource-type}
    • [AUTOFIX] titles/additional-rhdh-capabilities/additional-capabilities/additional-rhdh-capabilities.adoc: Line 506: Hardcoded "Backstage" -> {backstage} or {product-custom-resource-type}
    • [AUTOFIX] titles/additional-rhdh-capabilities/additional-capabilities/additional-rhdh-capabilities.adoc: Line 507: Hardcoded "Backstage" -> {backstage} or {product-custom-resource-type}
    • [AUTOFIX] titles/additional-rhdh-capabilities/additional-capabilities/additional-rhdh-capabilities.adoc: Line 607: Hardcoded "Backstage" -> {backstage} or {product-custom-resource-type}
    • [AUTOFIX] titles/additional-rhdh-capabilities/additional-capabilities/additional-rhdh-capabilities.adoc: Line 621: Hardcoded "Backstage" -> {backstage} or {product-custom-resource-type}
    • [AUTOFIX] titles/additional-rhdh-capabilities/additional-capabilities/additional-rhdh-capabilities.adoc: Line 622: Hardcoded "Backstage" -> {backstage} or {product-custom-resource-type}
    • [AUTOFIX] titles/additional-rhdh-capabilities/additional-capabilities/additional-rhdh-capabilities.adoc: Line 630: Hardcoded "Backstage" -> {backstage} or {product-custom-resource-type}
    • [AUTOFIX] modules/shared/proc-install-and-configure.adoc: Line 78: Hardcoded "LCS" -> {lcs-short}
  • CQA-1: Vale AsciiDoc DITA compliance
  • CQA-12: Verify grammar and style (Vale)
  • CQA-17: Verify legal disclaimers for preview features
    • [MANUAL] titles/additional-rhdh-capabilities/master.adoc: Line 5: Mentions 'Developer Preview' but may not include official disclaimer snippet
  • CQA-14: Verify no broken links
  • CQA-15: Check redirects

Total: 19 checks | 13 passed | 6 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

@sonarqubecloud
Copy link
Copy Markdown

@rhdh-bot
Copy link
Copy Markdown
Collaborator

Content Quality Assessment Results

CQA Summary Checklist

  • CQA-0: Find orphaned modules and images
  • CQA-0: Verify directory structure (_ naming)
    • [MANUAL] titles/additional-rhdh-capabilities/master.adoc: Missing :_mod-docs-category: attribute
  • CQA-3: Verify content type metadata
    • [AUTOFIX] titles/additional-rhdh-capabilities/master.adoc: Line 1: Content type: -> ASSEMBLY
  • CQA-13: Verify content matches declared type
  • CQA-10: Verify titles are brief, complete, and descriptive
  • CQA-8: Verify short description content quality
  • CQA-9: Verify short description format
  • CQA-11: Verify procedure prerequisites
  • CQA-2: Verify assembly structure
    • [AUTOFIX] titles/additional-rhdh-capabilities/master.adoc: Line 1: Content type ASSEMBLY not on first line
    • [-> CQA-9 AUTOFIX] titles/additional-rhdh-capabilities/master.adoc: Missing [role="_abstract"] introduction
  • CQA-5: Verify required modular elements
    • [-> CQA-3 AUTOFIX] titles/additional-rhdh-capabilities/master.adoc: Missing :_mod-docs-content-type: metadata
    • [-> CQA-2 AUTOFIX] titles/additional-rhdh-capabilities/master.adoc: Missing or incorrect topic ID (master.adoc should use [id="{context}"])
    • [-> CQA-9 AUTOFIX] titles/additional-rhdh-capabilities/master.adoc: Missing [role="_abstract"] short introduction
  • CQA-4: Verify module templates
  • CQA-6: Verify assemblies follow official template (one user story)
  • CQA-7: Verify TOC depth (max 3 levels)
  • CQA-16: Verify official product names
    • [AUTOFIX] titles/additional-rhdh-capabilities/additional-capabilities/additional-rhdh-capabilities.adoc: Line 423: Hardcoded "Backstage" -> {backstage} or {product-custom-resource-type}
    • [AUTOFIX] titles/additional-rhdh-capabilities/additional-capabilities/additional-rhdh-capabilities.adoc: Line 512: Hardcoded "Backstage" -> {backstage} or {product-custom-resource-type}
    • [AUTOFIX] titles/additional-rhdh-capabilities/additional-capabilities/additional-rhdh-capabilities.adoc: Line 513: Hardcoded "Backstage" -> {backstage} or {product-custom-resource-type}
    • [AUTOFIX] titles/additional-rhdh-capabilities/additional-capabilities/additional-rhdh-capabilities.adoc: Line 613: Hardcoded "Backstage" -> {backstage} or {product-custom-resource-type}
    • [AUTOFIX] titles/additional-rhdh-capabilities/additional-capabilities/additional-rhdh-capabilities.adoc: Line 627: Hardcoded "Backstage" -> {backstage} or {product-custom-resource-type}
    • [AUTOFIX] titles/additional-rhdh-capabilities/additional-capabilities/additional-rhdh-capabilities.adoc: Line 628: Hardcoded "Backstage" -> {backstage} or {product-custom-resource-type}
    • [AUTOFIX] titles/additional-rhdh-capabilities/additional-capabilities/additional-rhdh-capabilities.adoc: Line 636: Hardcoded "Backstage" -> {backstage} or {product-custom-resource-type}
    • [AUTOFIX] modules/shared/proc-install-and-configure.adoc: Line 78: Hardcoded "LCS" -> {lcs-short}
  • CQA-1: Vale AsciiDoc DITA compliance
  • CQA-12: Verify grammar and style (Vale)
  • CQA-17: Verify legal disclaimers for preview features
    • [MANUAL] titles/additional-rhdh-capabilities/master.adoc: Line 5: Mentions 'Developer Preview' but may not include official disclaimer snippet
    • [MANUAL] titles/additional-rhdh-capabilities/additional-capabilities/additional-rhdh-capabilities.adoc: Line 7: Mentions 'Technology Preview' but may not include official disclaimer snippet
    • [MANUAL] titles/additional-rhdh-capabilities/additional-capabilities/additional-rhdh-capabilities.adoc: Line 7: Mentions 'Developer Preview' but may not include official disclaimer snippet
  • CQA-14: Verify no broken links
  • CQA-15: Check redirects

Total: 19 checks | 13 passed | 6 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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants