RHIDP-17796: [Signals-Frontend] Update and Expand Product Documentation for GA

[jmagak]

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

Version(s): 2.1

Issue: RHIDP-17796

Preview:

[rhdh-bot]

PR Build Results

Build passed -- 38/38 titles | 128s
Preview: https://redhat-developer.github.io/red-hat-developers-documentation-rhdh/pr-2661/

---

Content Quality Assessment

CQA Report

• CQA-00a: Orphaned modules
• CQA-00b: Directory structure
• CQA-01: Vale AsciiDoc DITA compliance
• CQA-02: Verify assembly structure
• CQA-03: Verify content type metadata
• CQA-04: Verify module templates
• CQA-05: Verify required modular elements
• CQA-06: Verify assemblies follow official template (one user story)
• CQA-07: Verify TOC depth (max 3 levels)
• CQA-08: Verify short description content quality
• CQA-09: Verify short description format
• CQA-10: Verify titles are brief, complete, and descriptive
• CQA-11: Verify procedure prerequisites
• CQA-12: Verify grammar and style (Vale)
• CQA-13: Verify content matches declared type
• CQA-14: Verify no broken links
• CQA-14b: Inbound link stability (no ID changes for existing files)
• CQA-15: Check redirects
• CQA-16: Verify official product names
• CQA-17: Verify legal disclaimers for preview features
• CQA-jtbd-01: Verify navigation file structure
• CQA-jtbd-02: Modules not yet in product_product (informational)

---

Summary

Checks: 22 total, 22 pass, 0 fail

Modules not yet in product_product

61 modules (proc, con, ref) are not yet included in the product_product title.

modules/configure_configuring-rhdh/ (6)

• modules/configure_configuring-rhdh/con-http2-and-the-frontend-connection-bottleneck.adoc
• modules/configure_configuring-rhdh/proc-enable-http2-by-using-a-reverse-proxy-with-helm-on-third-party-kubernetes.adoc
• modules/configure_configuring-rhdh/proc-enable-http2-by-using-a-reverse-proxy-with-helm.adoc
• modules/configure_configuring-rhdh/proc-enable-http2-by-using-a-reverse-proxy-with-the-operator-on-third-party-kubernetes.adoc
• modules/configure_configuring-rhdh/proc-enable-http2-by-using-a-reverse-proxy-with-the-operator.adoc
• modules/configure_configuring-rhdh/ref-http2-tls-requirements.adoc

modules/develop_streamline-software-development-and-management-in-rhdh/ (8)

• modules/develop_streamline-software-development-and-management-in-rhdh/con-rhdh-templates-skill.adoc
• modules/develop_streamline-software-development-and-management-in-rhdh/proc-convert-a-codebase-into-a-software-template.adoc
• modules/develop_streamline-software-development-and-management-in-rhdh/proc-create-a-software-template-from-scratch.adoc
• modules/develop_streamline-software-development-and-management-in-rhdh/proc-install-the-rhdh-templates-skill.adoc
• modules/develop_streamline-software-development-and-management-in-rhdh/proc-set-up-a-template-authoring-environment.adoc
• modules/develop_streamline-software-development-and-management-in-rhdh/proc-test-a-template-against-a-running-rhdh-instance.adoc
• modules/develop_streamline-software-development-and-management-in-rhdh/proc-validate-a-software-template-locally.adoc
• modules/develop_streamline-software-development-and-management-in-rhdh/ref-rhdh-templates-skill-commands.adoc

modules/install_installing-rhdh-on-ocp/ (3)

• modules/install_installing-rhdh-on-ocp/con-arm64-architecture-support.adoc
• modules/install_installing-rhdh-on-ocp/proc-deploy-rhdh-on-arm64-clusters.adoc
• modules/install_installing-rhdh-on-ocp/ref-hardware-requirements-for-arm64-deployments.adoc

modules/shared/ (41)

• modules/shared/con-about-the-rhdh-cli.adoc
• modules/shared/con-agent-skills-for-the-intelligent-assistant.adoc
• modules/shared/con-bring-your-own-knowledge-base-for-lightspeed.adoc
• modules/shared/con-intelligent-assistant-configuration-changes-in-rhdh-2-1.adoc
• modules/shared/con-optimize-custom-plugins-for-fast-load-in-the-new-frontend-system.adoc
• modules/shared/con-permission-based-ui-visibility-for-a-cleaner-user-experience.adoc
• modules/shared/con-permission-types-for-rbac-ui-visibility-control.adoc
• modules/shared/con-unsupported-scenarios-and-constraints-for-rbac-ui-visibility.adoc
• modules/shared/con-user-experience-and-security-benefits-of-rbac-ui-hiding.adoc
• modules/shared/proc-authenticating-and-registering-action-sources-for-the-rhdh-cli.adoc
• modules/shared/proc-complete-the-intelligent-assistant-migration-with-the-helm-chart.adoc
• modules/shared/proc-complete-the-intelligent-assistant-migration-with-the-operator.adoc
• modules/shared/proc-configure-agent-skills-for-the-intelligent-assistant.adoc
• modules/shared/proc-configure-byok-rag-by-using-the-helm-chart.adoc
• modules/shared/proc-configure-byok-rag-by-using-the-operator.adoc
• modules/shared/proc-configure-rate-limits-for-intelligent-assistant.adoc
• modules/shared/proc-configure-rbac-visibility-rules-to-hide-unauthorized-ui-elements.adoc
• modules/shared/proc-configuring-rhdh-for-the-rhdh-cli.adoc
• modules/shared/proc-deploy-byok-rag-in-a-disconnected-environment.adoc
• modules/shared/proc-generate-a-vector-database-for-byok-rag.adoc
• modules/shared/proc-installing-the-rhdh-cli.adoc
• modules/shared/proc-migrate-intelligent-assistant-configuration-to-the-unified-file.adoc
• modules/shared/proc-mount-agent-skills-by-using-a-configmap.adoc
• modules/shared/proc-package-a-byok-rag-container-image.adoc
• modules/shared/proc-prepare-custom-content-for-byok-rag.adoc
• modules/shared/proc-record-intelligent-assistant-settings-to-prevent-migration-data-loss.adoc
• modules/shared/proc-update-agent-skills-for-the-intelligent-assistant.adoc
• modules/shared/proc-update-the-byok-rag-knowledge-base.adoc
• modules/shared/proc-verify-byok-rag-retrieval.adoc
• modules/shared/proc-verify-the-migrated-intelligent-assistant-deployment.adoc
• modules/shared/ref-ai-feature-permissions.adoc
• modules/shared/ref-byok-rag-configuration-fields-for-lightspeed-stack.adoc
• modules/shared/ref-byok-rag-troubleshooting.adoc
• modules/shared/ref-inference-providers-for-intelligent-assistant.adoc
• modules/shared/ref-limitations-for-agent-skills.adoc
• modules/shared/ref-new-frontend-system-plugin-optimization-patterns.adoc
• modules/shared/ref-permission-evaluation-behavior-for-ui-visibility.adoc
• modules/shared/ref-plugin-permissions-for-ui-visibility.adoc
• modules/shared/ref-rhdh-cli-commands-overview.adoc
• modules/shared/ref-troubleshoot-plugin-load-failures-in-the-new-frontend-system.adoc
• modules/shared/ref-ui-elements-with-rbac-visibility-control.adoc

modules/upgrade_upgrade-rhdh/ (3)

• modules/upgrade_upgrade-rhdh/con-rhdh-upgrade-helper-skill.adoc
• modules/upgrade_upgrade-rhdh/proc-run-the-rhdh-upgrade-helper-skill.adoc
• modules/upgrade_upgrade-rhdh/ref-rhdh-upgrade-helper-skill-configuration-inputs.adoc

22 checks: 22 pass, 0 fail

Run node build/scripts/cqa/index.js --all --fix locally to review and auto-fix issues.

---

Updated 2026-10-13 06:04:31 UTC

[ciiay]

Technical review

LGTM for Signals GA documentation.

• Correctly describes Signals as an enabling plugin (no UI of its own), with Notifications as the primary consumer
• GA support note is clear and does not imply Notifications is GA
• Points to the generated plugin support tables for status
• Enable procedure covers both frontend and backend packages and preserves the existing anchor

One ask before merge: please clarify (or remove) the optional events.http.topics: [signals] step. That config is for Events HTTP ingress (/api/events/http/signals), not something required for the usual Notifications → Signals real-time path. As written, admins enabling Signals for notifications may think they need it.

[pabel-rh]

Approved with some comments.

[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