RHDHBUGS-3277: Missing prerequisites and configuration details for Scorecard Aggregation cards#2346
RHDHBUGS-3277: Missing prerequisites and configuration details for Scorecard Aggregation cards#2346rh-tokeefe wants to merge 15 commits into
Conversation
PR Build ResultsBuild passed -- 35/35 titles | 78s Content Quality AssessmentCQA Report
SummaryChecks: 19 total, 19 pass, 0 fail 19 checks: 19 pass, 0 fail Run Updated 2026-06-12 20:35:11 UTC |
themr0c
added
Peer review needed 📖
Technical review needed 🔩
| xs: { w: 12, h: 6 } | ||
| xxs: { w: 12, h: 6 } | ||
| plugins: | ||
| - package: oci://ghcr.io/redhat-developer/rhdh-plugin-export-overlays/red-hat-developer-hub-backstage-plugin-scorecard:bs_1.45.3__2.3.5 |
There was a problem hiding this comment.
Please fix the outdated 1.45 reference
There was a problem hiding this comment.
To make sure user knows that he should only add new mountpoint (we are not repeating configuration for other keys like entityTabs, we should update the 3. step of the procedure
from:
3. Update the configuration to use the aggregationId property with an established system metric name:
to:
3. Add a new item to the mountPoints array, setting aggregationId to your preferred metric ID.
There was a problem hiding this comment.
Done.
@dzemanov just to confirm, this is the location where I can obtain that correct?
that way I can bookmark it and know where to look in the future.
There was a problem hiding this comment.
Yes, there you can obtain correct frontend scorecard plugin version for RHDH 1.10
| + | ||
| where: | ||
|
|
||
| `aggregationId`:: Specifies the ID in the mount point configuration, which is derived from the `metricId` of the installed scorecard module. |
There was a problem hiding this comment.
Please provide a link to where users can find what metric ids they can use: https://redhat-developer.github.io/red-hat-developers-documentation-rhdh/release-1.10/observability_evaluate-project-health-using-scorecards/#supported-scorecard-metrics-providers_evaluate-project-health-using-scorecards
There was a problem hiding this comment.
| `aggregationId`:: Specifies the ID in the mount point configuration, which is derived from the `metricId` of the installed scorecard module. | |
| `aggregationId`:: The aggregation identifier used in the mount point configuration, for default aggregation must match the `metricId` from your installed Scorecard module. |
| .Prerequisites | ||
|
|
||
| * The scorecard plugin is installed and configured in your {product} instance. | ||
| * You have installed and configured Scorecard backend and frontend plugins, and at least one Scorecard plugin module. |
There was a problem hiding this comment.
Can you please update this prerequisites also for all other sections that need it, as specified in the ticket?
Sections:
Configure a default scorecard aggregation card, Configure an aggregation card with a status-grouped tracking type, Configure an aggregation card with an average tracking type.
dzemanov
left a comment
dzemanov
left a comment
There was a problem hiding this comment.
@rh-tokeefe can you please also address in this PR bullet points of the issue: 3, 4, 5?
For bullet point 5, specify where user can locate mountpoint configuration, I see you updated mountpoint for default aggregation, but it needs to be updated also in status-grouped and average scorecards. To simplify, we could only specify where to locate mountpoints in text (should be under scorecard mountpoints key) and link to 1 full example in 9.4. Configure portfolio health on a customizable home page for customizable homepage and
9.5. Configure portfolio health on a read-only home page for read only homepage. This will be useful also for bullet point 3 of the jira ticket, to specify that mountpoint examples for defautl scorecard aggregation, status grouped and average aggregation are only showing how to configue it for read-only homepage and customizable homepage can be found in 9.4.
rh-tokeefe
added
do-not-merge/work-in-progress
and removed
Peer review needed 📖
Technical review needed 🔩
| . Navigate to your scorecard card block under the `home.page/cards` mount point. | ||
|
|
||
| . Update the configuration to use the `aggregationId` property with an established system metric name: | ||
| . Add a new item to the `mountpointsarray`, `settingaggregationId` to your preferred metric ID. |
There was a problem hiding this comment.
| . Add a new item to the `mountpointsarray`, `settingaggregationId` to your preferred metric ID. | |
| . Add a new item to the `mountPoints` array, setting `aggregationId` to your preferred metric ID. |
…orecard Aggregation cards
rh-tokeefe
force-pushed
the
RHDHBUGS-3277
branch
from
2abbe96 to
3da1047
Compare
…metric-ids Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
… also included Section 2 text
…e type clarification - Clarify mountpoint location in all three aggregation card procedures - Add notes indicating examples show read-only homepage configuration - Link to sections 9.4 and 9.5 for customizable and read-only homepage examples - Apply changes consistently across default, status-grouped, and average aggregation cards Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
Changed the two steps for finding Backstage and plugin versions from numbered list items to lettered sub-steps, which will render more cleanly as nested instructions under the tag parameter definition. Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
|
4 participants
IMPORTANT: Do Not Merge - To be merged by Docs Team Only
Version(s):
release 1.10
Issue:
https://redhat.atlassian.net/browse/RHDHBUGS-3277
Preview: