Skip to content

RHIDP-12636 - Adoption Insights - Display entity titles instead of names in info cards#2032

Open
Gerry-Forde wants to merge 28 commits intoredhat-developer:mainfrom
Gerry-Forde:RHIDP-12636
Open

RHIDP-12636 - Adoption Insights - Display entity titles instead of names in info cards#2032
Gerry-Forde wants to merge 28 commits intoredhat-developer:mainfrom
Gerry-Forde:RHIDP-12636

Conversation

@Gerry-Forde
Copy link
Copy Markdown
Member

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

Version(s):
main, 1.10

Issue:
RHIDP-12636

Preview:

@rhdh-bot
Copy link
Copy Markdown
Collaborator

rhdh-bot commented Apr 13, 2026

Content Quality Assessment Results

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-15: Check redirects
  • CQA-16: Verify official product names
  • CQA-17: Verify legal disclaimers for preview features

Summary

Checks: 19 total, 19 pass, 0 fail


Automated CQA check run on the entire repository — 2026-04-18 08:41:47 UTC

@rhdh-bot
Copy link
Copy Markdown
Collaborator

rhdh-bot commented Apr 13, 2026

❌ Build failed

33/33 titles built successfully | 0 failed | 124s

CQA (Content Quality Assessment)

19 checks: 18 pass, 1 fail

CQA checklist

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-15: Check redirects (31 issues)
    • [MANUAL] titles/configure_configuring-rhdh/master.adoc: Title changed: 'Configuring {product}' -> '{configuring-book-title}' -- may need redirect
    • [MANUAL] titles/configure_customizing-rhdh/master.adoc: Title changed: 'Customizing {product}' -> '{customizing-book-title}' -- may need redirect
    • [MANUAL] titles/configure_techdocs-for-rhdh/master.adoc: Title changed: 'TechDocs for {product}' -> '{techdocs-book-title}' -- may need redirect
    • [MANUAL] titles/control-access_authentication-in-rhdh/master.adoc: Title changed: 'Authentication in {product}' -> '{authentication-book-title}' -- may need redirect
    • [MANUAL] titles/control-access_authorization-in-rhdh/master.adoc: Title changed: 'Authorization in {product}' -> '{authorization-book-title}' -- may need redirect
    • [MANUAL] titles/develop_manage-and-consume-technical-documentation-within-rhdh/master.adoc: Title changed: 'Manage and consume technical documentation within {product}' -> '{manage-and-consume-techdocs-book-title}' -- may need redirect
    • [MANUAL] titles/develop_streamline-software-development-and-management-in-rhdh/master.adoc: Title changed: 'Streamline software development and management in {product}' -> '{streamline-software-development-and-management-in-rhdh-book-title}' -- may need redirect
    • [MANUAL] titles/discover_about-rhdh/master.adoc: Title changed: 'About {product}' -> '{about-book-title}' -- may need redirect
    • [MANUAL] titles/extend_configuring-dynamic-plugins/master.adoc: Title changed: 'Configuring dynamic plugins' -> '{configuring-dynamic-plugins-book-title}' -- may need redirect
    • [MANUAL] titles/extend_develop-and-deploy-pugins-in-rhdh/master.adoc: Title changed: 'Develop and deploy dynamic plugins in {product}' -> '{develop-and-deploy-dynamic-plugins-book-title}' -- may need redirect
    • [MANUAL] titles/extend_dynamic-plugins-reference/master.adoc: Title changed: 'Dynamic plugins reference' -> '{dynamic-plugins-reference-book-title}' -- may need redirect
    • [MANUAL] titles/extend_installing-and-viewing-plugins-in-rhdh/master.adoc: Title changed: 'Installing and viewing plugins in {product}' -> '{installing-and-viewing-plugins-book-title}' -- may need redirect
    • [MANUAL] titles/extend_orchestrator-in-rhdh/master.adoc: Title changed: 'Orchestrator in {product}' -> '{orchestrator-book-title}' -- may need redirect
    • [MANUAL] titles/extend_using-dynamic-plugins-in-rhdh/master.adoc: Title changed: 'Using dynamic plugins in {product}' -> '{using-dynamic-plugins-book-title}' -- may need redirect
    • [MANUAL] titles/get-started_navigate-rhdh-on-your-first-day/master.adoc: Title changed: 'Navigate {product} on your first day' -> '{navigate-rhdh-on-your-first-day-book-title}' -- may need redirect
    • [MANUAL] titles/get-started_setting-up-and-configuring-your-first-red-hat-developer-hub-instance/master.adoc: Title changed: 'Setting up and configuring your first {product} instance' -> '{setting-up-and-configuring-book-title}' -- may need redirect
    • [MANUAL] titles/install_installing-rhdh-in-an-air-gapped-environment/master.adoc: Title changed: 'Installing {product} in an air-gapped environment' -> '{installing-in-air-gap-book-title}' -- may need redirect
    • [MANUAL] titles/install_installing-rhdh-on-aks/master.adoc: Title changed: 'Installing {product} on {platform-long}' -> '{installing-on-aks-book-title}' -- may need redirect
    • [MANUAL] titles/install_installing-rhdh-on-eks/master.adoc: Title changed: 'Installing {product} on {platform-long}' -> '{installing-on-eks-book-title}' -- may need redirect
    • [MANUAL] titles/install_installing-rhdh-on-gke/master.adoc: Title changed: 'Installing {product} on {platform-long}' -> '{installing-on-gke-book-title}' -- may need redirect
    • [MANUAL] titles/install_installing-rhdh-on-ocp/master.adoc: Title changed: 'Install {product} on {ocp-short}' -> '{installing-on-ocp-book-title}' -- may need redirect
    • [MANUAL] titles/install_installing-rhdh-on-osd-on-gcp/master.adoc: Title changed: 'Installing {product} on {osd-short} on {gcp-brand-name}' -> '{installing-on-osd-on-gcp-book-title}' -- may need redirect
    • [MANUAL] titles/integrate_accelerating-ai-development-with-openshift-ai-connector-for-rhdh/master.adoc: Title changed: 'Accelerate AI development with {openshift-ai-connector-name}' -> '{openshift-ai-connector-for-rhdh-book-title}' -- may need redirect
    • [MANUAL] titles/integrate_interacting-with-developer-lightspeed-for-rhdh/master.adoc: Title changed: 'Interacting with {ls-brand-name}' -> '{developer-lightspeed-book-title}' -- may need redirect
    • [MANUAL] titles/integrate_interacting-with-model-context-protocol-tools-for-rhdh/master.adoc: Title changed: 'Interacting with Model Context Protocol tools for {product}' -> '{model-context-protocol-book-title}' -- may need redirect
    • [MANUAL] titles/observability_adoption-insights-in-rhdh/master.adoc: Title changed: 'Adoption Insights in {product}' -> '{adoption-insights-book-title}' -- may need redirect
    • [MANUAL] titles/observability_audit-logs-in-rhdh/master.adoc: Title changed: 'Audit logs in {product}' -> '{audit-log-book-title}' -- may need redirect
    • [MANUAL] titles/observability_evaluate-project-health-using-scorecards/master.adoc: Title changed: 'Evaluate project health using Scorecards' -> '{scorecard-plugin-book-title}' -- may need redirect
    • [MANUAL] titles/observability_monitoring-and-logging/master.adoc: Title changed: 'Monitoring and logging' -> '{monitoring-and-logging-book-title}' -- may need redirect
    • [MANUAL] titles/observability_telemetry-data-collection-and-analysis/master.adoc: Title changed: 'Telemetry data collection and analysis' -> '{telemetry-data-collection-book-title}' -- may need redirect
    • [MANUAL] titles/upgrade_upgrade-rhdh/master.adoc: Title changed: 'Upgrading {product}' -> '{upgrading-book-title}' -- may need redirect
  • CQA-16: Verify official product names
  • CQA-17: Verify legal disclaimers for preview features

Summary

Checks: 19 total, 18 pass, 1 fail
Issues: 31 total (0 autofixable, 31 manual, 1 delegated)

Run node build/scripts/cqa/index.js --all locally for details.

View full logs | 4/18/2026, 8:42:33 AM

Copy link
Copy Markdown
Member

@Eswaraiahsapram Eswaraiahsapram left a comment

Choose a reason for hiding this comment

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

Thanks @Gerry-Forde , looks good to me 🎉

@Gerry-Forde Gerry-Forde added Technical review done ⛅ Any procedure has been succesfully tested and removed Technical review needed 🔩 Test all the procedures labels Apr 13, 2026
@sonarqubecloud
Copy link
Copy Markdown

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

Labels

Peer review needed 📖 Technical review done ⛅ Any procedure has been succesfully tested

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants