Skip to content

RHDHBUGS-3956: Move Scorecard aggregation card config to app-config.y… - #2682

Open
jmagak wants to merge 1 commit into
redhat-developer:release-2.1from
jmagak:RHDHBUGS-3956-Update-Scorecard-configuration-of-aggregation-cards-NFS
Open

jmagak wants to merge 1 commit into
redhat-developer:release-2.1from
jmagak:RHDHBUGS-3956-Update-Scorecard-configuration-of-aggregation-cards-NFS

Conversation

@jmagak

@jmagak jmagak commented Oct 21, 2026

Copy link
Copy Markdown
Member

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

Version(s): 2.1

Issue: RHDHBUGS-3956

Preview:

@rhdh-bot

rhdh-bot commented Oct 21, 2026 •

Copy link
Copy Markdown
Collaborator

PR Build Results

Build passed -- 2/2 titles | 57s
Preview: https://redhat-developer.github.io/red-hat-developers-documentation-rhdh/pr-2682/


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

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

modules/extend_discovering-ai-assets-in-the-ai-catalog/ (7)
  • modules/extend_discovering-ai-assets-in-the-ai-catalog/con-ai-catalog-architecture.adoc
  • modules/extend_discovering-ai-assets-in-the-ai-catalog/con-ai-catalog-overview.adoc
  • modules/extend_discovering-ai-assets-in-the-ai-catalog/proc-browse-ai-assets-in-the-catalog.adoc
  • modules/extend_discovering-ai-assets-in-the-ai-catalog/proc-configure-ai-catalog-filters.adoc
  • modules/extend_discovering-ai-assets-in-the-ai-catalog/proc-enable-ai-catalog-plugin.adoc
  • modules/extend_discovering-ai-assets-in-the-ai-catalog/proc-view-ai-asset-details.adoc
  • modules/extend_discovering-ai-assets-in-the-ai-catalog/ref-ai-asset-entity-model.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-22 21:27:02 UTC

@jmagak
jmagak requested a review from dzemanov October 21, 2026 13:18
@jmagak
jmagak force-pushed the RHDHBUGS-3956-Update-Scorecard-configuration-of-aggregation-cards-NFS branch from 3a6e462 to 74db439 Compare October 22, 2026 06:58

@dzemanov dzemanov left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

@jmagak Thank you for updating the aggregation-card configuration. One related gap is in the preceding Monitor collective health chapter: it explains how to define and verify aggregated KPIs, but it does not explain that users must also configure a Scorecard aggregation card to display those KPIs on the Home page. Configuring scorecard.aggregationKPIs alone does not make the collective-health data visible, so the verification steps cannot succeed without the homepage-card configuration.

This is outside the ticket scope, but could you add a short cross-reference? It would make the current aggregation-card work much easier to discover.

In https://redhat-developer.github.io/red-hat-developers-documentation-rhdh/release-1.10/observability_evaluate-project-health-using-scorecards/#configure-aggregated-kpis-for-the-scorecard_monitor-collective-health-across-components Procedure, add Step 5:

To display aggregated KPIs on the Home page, configure a Scorecard aggregation card. For more information, see {scorecard-plugin-book-link}#configure-scorecard-cards-on-the-homepage_evaluate-project-health-using-scorecards[Configure Scorecard cards on the homepage].

@jmagak
jmagak force-pushed the RHDHBUGS-3956-Update-Scorecard-configuration-of-aggregation-cards-NFS branch from 74db439 to 507b8c1 Compare October 22, 2026 14:58
@jmagak
jmagak requested a review from dzemanov October 22, 2026 15:36
@jmagak
jmagak force-pushed the RHDHBUGS-3956-Update-Scorecard-configuration-of-aggregation-cards-NFS branch from 507b8c1 to 41649de Compare October 22, 2026 15:36
@jmagak
jmagak force-pushed the RHDHBUGS-3956-Update-Scorecard-configuration-of-aggregation-cards-NFS branch from 303366c to 41649de Compare October 22, 2026 20:01

@dzemanov dzemanov left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Thank you for all the changes.

LGTM

…aml for NFS

Migrate Scorecard aggregation card examples from the home.page/cards mount
point in dynamic-plugins.yaml to the New Frontend System (NFS) configuration
in app-config.yaml: app.extensions widgetLayout plus homepage.defaultWidgets.

- Update read-only and customizable home page procedures
- Update default, status-grouped, scalar, and weighted tracking-type procedures
- Use lower camelCase for custom aggregation IDs (teamAlphaBugs, portfolioAverageHealth)
- Refresh the card configuration parameters reference to app-config properties
@jmagak
jmagak force-pushed the RHDHBUGS-3956-Update-Scorecard-configuration-of-aggregation-cards-NFS branch from 41649de to 157ee64 Compare October 22, 2026 21:24
@sonarqubecloud

Copy link
Copy Markdown

@jmagak jmagak added Technical review done ⛅ Any procedure has been succesfully tested and removed Technical review needed 🔩 Test all the procedures labels Oct 22, 2026

This branch was successfully deployed

1 active deployment
internal — 157ee648 Deployed Oct 22, 2026 by jmagak via authorize #11754
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants