From f124e17509f83cbf2db14bdaabb3f6ffb3b776c9 Mon Sep 17 00:00:00 2001 From: Tim O'Keefe Date: Mon, 11 May 2026 09:01:39 -0400 Subject: [PATCH 01/11] RHIDP-12524: Platform engineer define, name, and view aggregated KPIs for homepage --- ...r-collective-health-across-components.adoc | 7 ++- .../con-aggregated-kpis-in-the-scorecard.adoc | 13 ++++ ...ure-aggregated-kpis-for-the-scorecard.adoc | 49 +++++++++++++++ ...r-the-health-of-multiple-applications.adoc | 61 +++++++++++++++++++ 4 files changed, 129 insertions(+), 1 deletion(-) create mode 100644 modules/observability_evaluate-project-health-using-scorecards/con-aggregated-kpis-in-the-scorecard.adoc create mode 100644 modules/observability_evaluate-project-health-using-scorecards/proc-configure-aggregated-kpis-for-the-scorecard.adoc create mode 100644 modules/observability_evaluate-project-health-using-scorecards/proc-configure-aggregated-scorecard-kpis-to-monitor-the-health-of-multiple-applications.adoc diff --git a/assemblies/observability_evaluate-project-health-using-scorecards/assembly-monitor-collective-health-across-components.adoc b/assemblies/observability_evaluate-project-health-using-scorecards/assembly-monitor-collective-health-across-components.adoc index 863504b396d..e9bf26e8629 100644 --- a/assemblies/observability_evaluate-project-health-using-scorecards/assembly-monitor-collective-health-across-components.adoc +++ b/assemblies/observability_evaluate-project-health-using-scorecards/assembly-monitor-collective-health-across-components.adoc @@ -4,13 +4,18 @@ ifdef::context[:parent-context: {context}] [id="monitor-collective-health-across-components_{context}"] = Monitor collective health across components - :context: monitor-collective-health-across-components [role="_abstract"] As an administrator, you can use the Scorecard plugin to view the collective technical health across multiple owned applications or components. This consolidated view helps you identify high-level health trends and risks across complex projects. include::../modules/observability_evaluate-project-health-using-scorecards/con-monitor-portfolio-health-with-aggregated-kpis.adoc[leveloffset=+1] +include::../modules/observability_evaluate-project-health-using-scorecards/con-aggregated-kpis-in-the-scorecard.adoc[leveloffset=+1] + +include::../modules/observability_evaluate-project-health-using-scorecards/proc-configure-aggregated-kpis-for-the-scorecard.adoc[leveloffset=+1] + +include::../modules/observability_evaluate-project-health-using-scorecards/proc-configure-aggregated-scorecard-kpis-to-monitor-the-health-of-multiple-applications.adoc[leveloffset=+1] + include::../modules/observability_evaluate-project-health-using-scorecards/proc-configure-portfolio-health-on-a-customizable-home-page.adoc[leveloffset=+1] include::../modules/observability_evaluate-project-health-using-scorecards/proc-configure-portfolio-health-on-a-read-only-home-page.adoc[leveloffset=+1] diff --git a/modules/observability_evaluate-project-health-using-scorecards/con-aggregated-kpis-in-the-scorecard.adoc b/modules/observability_evaluate-project-health-using-scorecards/con-aggregated-kpis-in-the-scorecard.adoc new file mode 100644 index 00000000000..652c4eadb9f --- /dev/null +++ b/modules/observability_evaluate-project-health-using-scorecards/con-aggregated-kpis-in-the-scorecard.adoc @@ -0,0 +1,13 @@ +:_mod-docs-content-type: CONCEPT + +[id="aggregated-kpis-in-the-scorecard_{context}"] += Aggregated KPIs in the scorecard + +[role="_abstract"] +Monitor the technical health and regulatory compliance of your infrastructure by using aggregated Key Performance Indicators (KPIs). These KPIs summarize complex data from multiple entities into a high-level overview, allowing you to identify system risks quickly. + +Aggregated KPIs allow engineering and product managers to monitor the collective status of all components or applications owned by a specific group in the Software Catalog. Instead of manually inspecting individual service scorecards, managers can use these metrics to identify broad trends or risks within their portfolio. + +Aggregated metrics rely on the `owner` field defined in the Software Catalog entities to determine which data points to include. The scorecard plugin performs scheduled batch processing to calculate these values; therefore, aggregated data is not updated in real-time. + +The plugin supports simple aggregation logic, such as summing values (SUM) or calculating averages (AVERAGE) across entities. \ No newline at end of file diff --git a/modules/observability_evaluate-project-health-using-scorecards/proc-configure-aggregated-kpis-for-the-scorecard.adoc b/modules/observability_evaluate-project-health-using-scorecards/proc-configure-aggregated-kpis-for-the-scorecard.adoc new file mode 100644 index 00000000000..26afc1a5cc9 --- /dev/null +++ b/modules/observability_evaluate-project-health-using-scorecards/proc-configure-aggregated-kpis-for-the-scorecard.adoc @@ -0,0 +1,49 @@ +:_mod-docs-content-type: PROCEDURE + +[id="configure-aggregated-kpis-for-the-scorecard_{context}"] += Configure aggregated KPIs for the scorecard + +[role="_abstract"] +Define aggregated Key Performance Indicators (KPIs) in your configuration to provide a consolidated view of team or group health. Aggregating KPIs allows you to summarize technical metrics into high-level insights for management and stakeholders. + +.Prerequisites +* The scorecard plugin is installed and configured in your Red Hat Developer Hub instance. +* You have identified the `metricId` and the `owner` group from the Software Catalog you wish to aggregate. + +.Procedure + +. Access your `app-config.yaml` file. + +. Navigate to the `scorecard` section and add an `aggregations` block. + +. Update the configuration to create a homepage card that summarizes a specific metric for a team portfolio. The following example calculates the total bug count for all components owned by Team Alpha: ++ +[source,yaml] +---- +scorecard: + aggregations: + - id: team-alpha-total-bugs + name: "Total Open Bugs (Team Alpha)" + description: "Aggregated sum of Jira bugs across all Team Alpha components" + type: sum + metricId: jira.open_bugs + selector: + owner: group:default/team-alpha +---- ++ +where: ++ +`scorecard.aggregations.id`:: Specifies a unique identifier for the aggregated KPI. +`scorecard.aggregations.name`:: Specifies the name displayed on the homepage card. +`scorecard.aggregations.description`:: Specifies A brief explanation of what the metric represents. +`scorecard.aggregations.type`:: Specifies the aggregation function. Supported values include `sum` and `average`. +`scorecard.aggregations.metricId`:: Specifies the ID of the source metric from individual scorecards. +`scorecard.aggregations.selector`:: Specifies the criteria used to group entities, typically defined by `owner`. + +. Save the configuration and restart your Red Hat Developer Hub instance. [cite: 5360, 3931] + +.Verification + +. Navigate to the {product-short} homepage. + +. Verify that the new aggregated card is displayed with the defined name and calculated value. \ No newline at end of file diff --git a/modules/observability_evaluate-project-health-using-scorecards/proc-configure-aggregated-scorecard-kpis-to-monitor-the-health-of-multiple-applications.adoc b/modules/observability_evaluate-project-health-using-scorecards/proc-configure-aggregated-scorecard-kpis-to-monitor-the-health-of-multiple-applications.adoc new file mode 100644 index 00000000000..acc1c9aa2f0 --- /dev/null +++ b/modules/observability_evaluate-project-health-using-scorecards/proc-configure-aggregated-scorecard-kpis-to-monitor-the-health-of-multiple-applications.adoc @@ -0,0 +1,61 @@ +:_mod-docs-content-type: PROCEDURE + +[id="configure-aggregated-scorecard-kpis-to-monitor-the-health-of-multiple-applications_{context}"] += Configure aggregated Scorecard KPIs to monitor the health of multiple applications + +[role="_abstract"] +Configure the {product} Scorecard plugin to enable drill-down capabilities. This allows you to investigate the specific catalog entities and metrics that contribute to aggregated KPI scores, helping to identify and troubleshoot failing applications across a portfolio. + +.Prerequisites + +* You have installed {product}. +* You have configured at least one Scorecard metric provider, such as GitHub or Jira. +* You have configured aggregated KPIs. + +.Procedure + +. Define the metric ID for drill-down in your `app-config.yaml` file. ++ +Drill-downs are metric-scoped. Even when you click an aggregated KPI, the system requires the underlying `metricId` to query the catalog for related entities. ++ +[source,yaml] +---- +jira: + product: cloud + baseUrl: ${JIRA_URL} + token: ${JIRA_TOKEN} +jira: + product: cloud + baseUrl: ${JIRA_URL} + token: ${JIRA_TOKEN} +scorecard: + plugins: + jira: + open_issues: + schedule: + frequency: { minutes: 5 } + timeout: { minutes: 10 } + initialDelay: { seconds: 10 } +---- + +. Configure Role-Based Access Control (RBAC) permissions for the relevant user roles to enable scorecard access. + +.. Open your RBAC policy file, typically `rbac-policy.csv`. + +.. Add the following permission to read both scorecard metrics and catalog entities. ++ +[source,csv] +---- +p, role:default/team_lead, scorecard.metric.read, read, allow +p, role:default/team_lead, catalog.entity.read, read, allow +---- + +.Verification + +.. Navigate to the {product} Home Page. + +.. Click an aggregated KPI tile, such as *Critical Jira Issues*. + +.. Verify that a list of individual catalog entities appears, showing the components contributing to that aggregate score. ++ +If the list does not appear, ensure you are using the latest version of the {product-very-short} plugins. From 5c06a9f0cafb4aa7861c416a787cb84f6cc41565 Mon Sep 17 00:00:00 2001 From: Tim O'Keefe Date: Fri, 15 May 2026 10:38:03 -0400 Subject: [PATCH 02/11] RHIDP-12524: updated files based on dev review of the additional topics --- ...r-collective-health-across-components.adoc | 2 +- .../con-aggregated-kpis-in-the-scorecard.adoc | 2 +- ...ure-aggregated-kpis-for-the-scorecard.adoc | 35 +++++++++---------- ...trics-from-aggregated-scorecard-kpis.adoc} | 10 ++---- 4 files changed, 21 insertions(+), 28 deletions(-) rename modules/observability_evaluate-project-health-using-scorecards/{proc-configure-aggregated-scorecard-kpis-to-monitor-the-health-of-multiple-applications.adoc => proc-view-detailed-metrics-from-aggregated-scorecard-kpis.adoc} (86%) diff --git a/assemblies/observability_evaluate-project-health-using-scorecards/assembly-monitor-collective-health-across-components.adoc b/assemblies/observability_evaluate-project-health-using-scorecards/assembly-monitor-collective-health-across-components.adoc index e9bf26e8629..ceb1b8ec797 100644 --- a/assemblies/observability_evaluate-project-health-using-scorecards/assembly-monitor-collective-health-across-components.adoc +++ b/assemblies/observability_evaluate-project-health-using-scorecards/assembly-monitor-collective-health-across-components.adoc @@ -14,7 +14,7 @@ include::../modules/observability_evaluate-project-health-using-scorecards/con-a include::../modules/observability_evaluate-project-health-using-scorecards/proc-configure-aggregated-kpis-for-the-scorecard.adoc[leveloffset=+1] -include::../modules/observability_evaluate-project-health-using-scorecards/proc-configure-aggregated-scorecard-kpis-to-monitor-the-health-of-multiple-applications.adoc[leveloffset=+1] +include::../modules/observability_evaluate-project-health-using-scorecards/proc-view-detailed-metrics-from-aggregated-scorecard-kpis.adoc[leveloffset=+1] include::../modules/observability_evaluate-project-health-using-scorecards/proc-configure-portfolio-health-on-a-customizable-home-page.adoc[leveloffset=+1] diff --git a/modules/observability_evaluate-project-health-using-scorecards/con-aggregated-kpis-in-the-scorecard.adoc b/modules/observability_evaluate-project-health-using-scorecards/con-aggregated-kpis-in-the-scorecard.adoc index 652c4eadb9f..af47b7c19a6 100644 --- a/modules/observability_evaluate-project-health-using-scorecards/con-aggregated-kpis-in-the-scorecard.adoc +++ b/modules/observability_evaluate-project-health-using-scorecards/con-aggregated-kpis-in-the-scorecard.adoc @@ -6,7 +6,7 @@ [role="_abstract"] Monitor the technical health and regulatory compliance of your infrastructure by using aggregated Key Performance Indicators (KPIs). These KPIs summarize complex data from multiple entities into a high-level overview, allowing you to identify system risks quickly. -Aggregated KPIs allow engineering and product managers to monitor the collective status of all components or applications owned by a specific group in the Software Catalog. Instead of manually inspecting individual service scorecards, managers can use these metrics to identify broad trends or risks within their portfolio. +Aggregated KPIs allow engineering and product managers to monitor the collective status of all entities the viewer owns in the Software Catalog. Instead of manually inspecting individual service scorecards, managers can use these metrics to identify broad trends or risks within their portfolio. Aggregated metrics rely on the `owner` field defined in the Software Catalog entities to determine which data points to include. The scorecard plugin performs scheduled batch processing to calculate these values; therefore, aggregated data is not updated in real-time. diff --git a/modules/observability_evaluate-project-health-using-scorecards/proc-configure-aggregated-kpis-for-the-scorecard.adoc b/modules/observability_evaluate-project-health-using-scorecards/proc-configure-aggregated-kpis-for-the-scorecard.adoc index 26afc1a5cc9..ca3a1c4e3fc 100644 --- a/modules/observability_evaluate-project-health-using-scorecards/proc-configure-aggregated-kpis-for-the-scorecard.adoc +++ b/modules/observability_evaluate-project-health-using-scorecards/proc-configure-aggregated-kpis-for-the-scorecard.adoc @@ -7,40 +7,37 @@ Define aggregated Key Performance Indicators (KPIs) in your configuration to provide a consolidated view of team or group health. Aggregating KPIs allows you to summarize technical metrics into high-level insights for management and stakeholders. .Prerequisites -* The scorecard plugin is installed and configured in your Red Hat Developer Hub instance. -* You have identified the `metricId` and the `owner` group from the Software Catalog you wish to aggregate. +* The scorecard plugin is installed and configured in your {product} instance. +* You have identified the `metricId` you wish to aggregate. .Procedure . Access your `app-config.yaml` file. -. Navigate to the `scorecard` section and add an `aggregations` block. +. Navigate to the `scorecard` section and add an `aggregationKPIs` block. -. Update the configuration to create a homepage card that summarizes a specific metric for a team portfolio. The following example calculates the total bug count for all components owned by Team Alpha: +. Update the configuration to create a homepage card that summarizes a specific metric for a team portfolio. The following example adds a Jira open issues card that groups counts by threshold status for entities the signed-in user owns: + [source,yaml] ---- scorecard: aggregations: - - id: team-alpha-total-bugs - name: "Total Open Bugs (Team Alpha)" - description: "Aggregated sum of Jira bugs across all Team Alpha components" - type: sum - metricId: jira.open_bugs - selector: - owner: group:default/team-alpha + openIssuesKpi: + title: 'Jira open issues KPI' + description: 'Open issues across entities you own, grouped by status.' + type: statusGrouped + metricId: jira.open_issues ---- + where: + -`scorecard.aggregations.id`:: Specifies a unique identifier for the aggregated KPI. -`scorecard.aggregations.name`:: Specifies the name displayed on the homepage card. -`scorecard.aggregations.description`:: Specifies A brief explanation of what the metric represents. -`scorecard.aggregations.type`:: Specifies the aggregation function. Supported values include `sum` and `average`. -`scorecard.aggregations.metricId`:: Specifies the ID of the source metric from individual scorecards. -`scorecard.aggregations.selector`:: Specifies the criteria used to group entities, typically defined by `owner`. - -. Save the configuration and restart your Red Hat Developer Hub instance. [cite: 5360, 3931] +`scorecard.aggregationKPIs`:: Map of KPI keys to KPI definitions. Each key is an aggregation ID. For example `openIssuesKpi`. +`title`:: Title shown for the KPI. +`description`:: Short description of the KPI. +`type`:: Aggregation strategy. Use `statusGrouped` for counts per threshold status, or `average` for a weighted portfolio score. +`metricId`:: Metric provider ID. For example `jira.open_issues`, `github.open_prs`. + +. Save the configuration and restart your {product} instance. .Verification diff --git a/modules/observability_evaluate-project-health-using-scorecards/proc-configure-aggregated-scorecard-kpis-to-monitor-the-health-of-multiple-applications.adoc b/modules/observability_evaluate-project-health-using-scorecards/proc-view-detailed-metrics-from-aggregated-scorecard-kpis.adoc similarity index 86% rename from modules/observability_evaluate-project-health-using-scorecards/proc-configure-aggregated-scorecard-kpis-to-monitor-the-health-of-multiple-applications.adoc rename to modules/observability_evaluate-project-health-using-scorecards/proc-view-detailed-metrics-from-aggregated-scorecard-kpis.adoc index acc1c9aa2f0..e4fa188e194 100644 --- a/modules/observability_evaluate-project-health-using-scorecards/proc-configure-aggregated-scorecard-kpis-to-monitor-the-health-of-multiple-applications.adoc +++ b/modules/observability_evaluate-project-health-using-scorecards/proc-view-detailed-metrics-from-aggregated-scorecard-kpis.adoc @@ -1,7 +1,7 @@ :_mod-docs-content-type: PROCEDURE -[id="configure-aggregated-scorecard-kpis-to-monitor-the-health-of-multiple-applications_{context}"] -= Configure aggregated Scorecard KPIs to monitor the health of multiple applications +[id="view-detailed-metrics-from-aggregated-scorecard-kpis_{context}"] += View detailed metrics from aggregated scorecard KPIs [role="_abstract"] Configure the {product} Scorecard plugin to enable drill-down capabilities. This allows you to investigate the specific catalog entities and metrics that contribute to aggregated KPI scores, helping to identify and troubleshoot failing applications across a portfolio. @@ -23,11 +23,7 @@ Drill-downs are metric-scoped. Even when you click an aggregated KPI, the system jira: product: cloud baseUrl: ${JIRA_URL} - token: ${JIRA_TOKEN} -jira: - product: cloud - baseUrl: ${JIRA_URL} - token: ${JIRA_TOKEN} + token: ${JIRA_TOKEN} scorecard: plugins: jira: From ae78ff52c8ca180289dca9d41d1bfb6a873bdda9 Mon Sep 17 00:00:00 2001 From: Tim O'Keefe Date: Fri, 15 May 2026 13:56:34 -0400 Subject: [PATCH 03/11] RHIDP-12524: minor edit --- .../proc-configure-aggregated-kpis-for-the-scorecard.adoc | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/modules/observability_evaluate-project-health-using-scorecards/proc-configure-aggregated-kpis-for-the-scorecard.adoc b/modules/observability_evaluate-project-health-using-scorecards/proc-configure-aggregated-kpis-for-the-scorecard.adoc index ca3a1c4e3fc..3077fd76e4c 100644 --- a/modules/observability_evaluate-project-health-using-scorecards/proc-configure-aggregated-kpis-for-the-scorecard.adoc +++ b/modules/observability_evaluate-project-health-using-scorecards/proc-configure-aggregated-kpis-for-the-scorecard.adoc @@ -16,12 +16,12 @@ Define aggregated Key Performance Indicators (KPIs) in your configuration to pro . Navigate to the `scorecard` section and add an `aggregationKPIs` block. -. Update the configuration to create a homepage card that summarizes a specific metric for a team portfolio. The following example adds a Jira open issues card that groups counts by threshold status for entities the signed-in user owns: +. Update the configuration to create a homepage card that summarizes a specific metric for a team portfolio. The following example adds a Jira open issues card that groups counts by threshold status for the entities that the signed-in user owns: + [source,yaml] ---- scorecard: - aggregations: + aggregationKPIs: openIssuesKpi: title: 'Jira open issues KPI' description: 'Open issues across entities you own, grouped by status.' From 2b24c7e06dcb81a4173a9a4ffd10953a30f8e4f4 Mon Sep 17 00:00:00 2001 From: Tim O'Keefe Date: Mon, 18 May 2026 09:26:47 -0400 Subject: [PATCH 04/11] RHIDP-12524: edits from dev review. added new topics --- ...r-collective-health-across-components.adoc | 11 +++- ...-a-default-scorecard-aggregation-card.adoc | 43 ++++++++++++ ...tion-card-with-a-custom-tracking-type.adoc | 65 +++++++++++++++++++ ...orecard-card-configuration-parameters.adoc | 25 +++++++ ...gin-rest-api-endpoints-and-parameters.adoc | 25 +++++++ 5 files changed, 168 insertions(+), 1 deletion(-) create mode 100644 modules/observability_evaluate-project-health-using-scorecards/proc-configure-a-default-scorecard-aggregation-card.adoc create mode 100644 modules/observability_evaluate-project-health-using-scorecards/proc-configure-an-aggregation-card-with-a-custom-tracking-type.adoc create mode 100644 modules/observability_evaluate-project-health-using-scorecards/ref-scorecard-card-configuration-parameters.adoc create mode 100644 modules/observability_evaluate-project-health-using-scorecards/ref-scorecard-plugin-rest-api-endpoints-and-parameters.adoc diff --git a/assemblies/observability_evaluate-project-health-using-scorecards/assembly-monitor-collective-health-across-components.adoc b/assemblies/observability_evaluate-project-health-using-scorecards/assembly-monitor-collective-health-across-components.adoc index ceb1b8ec797..50760f57b41 100644 --- a/assemblies/observability_evaluate-project-health-using-scorecards/assembly-monitor-collective-health-across-components.adoc +++ b/assemblies/observability_evaluate-project-health-using-scorecards/assembly-monitor-collective-health-across-components.adoc @@ -14,10 +14,14 @@ include::../modules/observability_evaluate-project-health-using-scorecards/con-a include::../modules/observability_evaluate-project-health-using-scorecards/proc-configure-aggregated-kpis-for-the-scorecard.adoc[leveloffset=+1] -include::../modules/observability_evaluate-project-health-using-scorecards/proc-view-detailed-metrics-from-aggregated-scorecard-kpis.adoc[leveloffset=+1] +include::../modules/observability_evaluate-project-health-using-scorecards/proc-configure-a-default-scorecard-aggregation-card.adoc[leveloffset=+1] + +include::../modules/observability_evaluate-project-health-using-scorecards/proc-configure-an-aggregation-card-with-a-custom-tracking-type.adoc[leveloffset=+1] include::../modules/observability_evaluate-project-health-using-scorecards/proc-configure-portfolio-health-on-a-customizable-home-page.adoc[leveloffset=+1] +include::../modules/observability_evaluate-project-health-using-scorecards/proc-view-detailed-metrics-from-aggregated-scorecard-kpis.adoc[leveloffset=+1] + include::../modules/observability_evaluate-project-health-using-scorecards/proc-configure-portfolio-health-on-a-read-only-home-page.adoc[leveloffset=+1] include::../modules/observability_evaluate-project-health-using-scorecards/proc-schedule-metrics-to-avoid-api-limits.adoc[leveloffset=+1] @@ -29,5 +33,10 @@ include::../modules/observability_evaluate-project-health-using-scorecards/ref-e include::../modules/observability_evaluate-project-health-using-scorecards/proc-view-aggregated-metrics-for-owned-entities.adoc[leveloffset=+1] include::../modules/observability_evaluate-project-health-using-scorecards/ref-available-metric-data-for-entities.adoc[leveloffset=+1] + +include::../modules/observability_evaluate-project-health-using-scorecards/ref-scorecard-card-configuration-parameters.adoc[leveloffset=+1] + +include::../modules/observability_evaluate-project-health-using-scorecards/ref-scorecard-plugin-rest-api-endpoints-and-parameters.adoc[leveloffset=+1] + ifdef::parent-context[:context: {parent-context}] ifndef::parent-context[:!context:] diff --git a/modules/observability_evaluate-project-health-using-scorecards/proc-configure-a-default-scorecard-aggregation-card.adoc b/modules/observability_evaluate-project-health-using-scorecards/proc-configure-a-default-scorecard-aggregation-card.adoc new file mode 100644 index 00000000000..5ca17d265d9 --- /dev/null +++ b/modules/observability_evaluate-project-health-using-scorecards/proc-configure-a-default-scorecard-aggregation-card.adoc @@ -0,0 +1,43 @@ +:_mod-docs-content-type: PROCEDURE + +[id="configure-a-default-scorecard-aggregation-card_{context}"] += Configure a default scorecard aggregation card + +[role="_abstract"] +Add a standard scorecard summary card to your homepage using default, out-of-the-box configurations. + +.Prerequisites + +* The scorecard plugin is installed and configured in your {product} instance. + +* You have administrator permissions to update application configuration files. + +.Procedure +. Open your dynamic plugin configuration file. + +. 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: ++ +[source,yaml] +---- +- mountPoint: home.page/cards + importName: ScorecardHomepageCard + config: + props: + aggregationId: "github.open_prs" + layouts: + xl: { w: 3, h: 6, x: 3 } + lg: { w: 4, h: 6, x: 4 } + md: { w: 6, h: 6, x: 6 } + sm: { w: 12, h: 6 } + xs: { w: 12, h: 6 } + xxs: { w: 12, h: 6 } +---- + +. Save the modified configuration file and restart your {product} instance. + +.Verification +* Access your {roduct-short} homepage interface. + +* Verify that the standard scorecard summary card displays with default metrics. \ No newline at end of file diff --git a/modules/observability_evaluate-project-health-using-scorecards/proc-configure-an-aggregation-card-with-a-custom-tracking-type.adoc b/modules/observability_evaluate-project-health-using-scorecards/proc-configure-an-aggregation-card-with-a-custom-tracking-type.adoc new file mode 100644 index 00000000000..5b613492723 --- /dev/null +++ b/modules/observability_evaluate-project-health-using-scorecards/proc-configure-an-aggregation-card-with-a-custom-tracking-type.adoc @@ -0,0 +1,65 @@ +:_mod-docs-content-type: PROCEDURE + +[id="configure-an-aggregation-card-with-a-custom-tracking-type_{context}"] += Configure an aggregation card with a custom tracking type + +[role="_abstract"] +Configure a scorecard aggregation card to display status-grouped metric counts or weighted portfolio scores across multiple components. + +.Prerequisites + +* The scorecard plugin is installed and configured in your {product} instance. + +* You have identified the source metric provider and group from the Software Catalog you wish to aggregate. + +.Procedure +. Open your `app-config.yaml` file. + +. Navigate to the `scorecard` section and define your backend Key Performance Indicator (KPI) map within an `aggregationKPIs` block: ++ +[source,yaml] +---- +scorecard: + aggregationKPIs: + team-alpha-bugs: + title: "Team Alpha Bug KPI" + description: "Portfolio bug counts grouped by status threshold" + type: statusGrouped + metricId: jira.open_issues +---- + +. Open your dynamic plugin configuration file. + +. Reference your custom aggregation ID inside the homepage card properties block under the `home.page/cards` mount point: ++ +[source,yaml] +---- +- mountPoint: home.page/cards + importName: ScorecardHomepageCard + config: + props: + aggregationId: "team-alpha-bugs" + layouts: + xl: { w: 3, h: 6 } + lg: { w: 4, h: 6 } + md: { w: 6, h: 6 } + sm: { w: 12, h: 6 } + xs: { w: 12, h: 6 } + xxs: { w: 12, h: 6 } +---- ++ +where: ++ +`scorecard.aggregationKPIs`:: Map of KPI keys to KPI definitions. Each key is an aggregation ID. +`title`:: Title shown for the KPI. +`description`:: Short description of the KPI. +`type`:: Aggregation strategy. Use `statusGrouped` for counts per threshold status, or `average` for a weighted portfolio score. +`metricId`:: Metric provider ID. + +. Save the modified configuration files and restart your {product} instance. + +.Verification + +* Access your {product} interface. + +* Verify that the custom scorecard summary card displays with your defined title and calculated values. \ No newline at end of file diff --git a/modules/observability_evaluate-project-health-using-scorecards/ref-scorecard-card-configuration-parameters.adoc b/modules/observability_evaluate-project-health-using-scorecards/ref-scorecard-card-configuration-parameters.adoc new file mode 100644 index 00000000000..82d4b01ad65 --- /dev/null +++ b/modules/observability_evaluate-project-health-using-scorecards/ref-scorecard-card-configuration-parameters.adoc @@ -0,0 +1,25 @@ +:_mod-docs-content-type: REFERENCE + +[id="ref-scorecard-card-configuration-parameters_{context}"] += Scorecard card configuration parameters + +[role="_abstract"] +Parameters for application settings and dynamic plugin files used to manage homepage visualizations and portfolio data logic. + +== Dynamic plugin properties +[cols="1,3",options="header"] +|=== +|Property |Description +|`aggregationId` |The target identifier for the homepage visualization block. Accepts a default system metric name string or a custom KPI key mapped in your core settings. +|`metricId` |[Deprecated] Legacy identifier for the source metric string. Supported for backwards compatibility but scheduled for removal in a future release. Replace with `aggregationId`. +|=== + +== Application configuration properties (`scorecard.aggregationKPIs`) +[cols="1,3",options="header"] +|=== +|Property |Description +|`title` |The primary textual label rendered on the header block of the homepage card. +|`description` |A brief text string summarizing the target scope of the KPI. +|`type` |The structural tracking strategy. Specify `statusGrouped` to return independent numerical entity counts per threshold status layer, or specify `average` to calculate a single weighted portfolio score. +|`metricId` |The unique provider identifier mapping to the individual source plugin collection layer, such as `jira.open_issues` or `github.open_prs`. +|=== \ No newline at end of file diff --git a/modules/observability_evaluate-project-health-using-scorecards/ref-scorecard-plugin-rest-api-endpoints-and-parameters.adoc b/modules/observability_evaluate-project-health-using-scorecards/ref-scorecard-plugin-rest-api-endpoints-and-parameters.adoc new file mode 100644 index 00000000000..a4040573f06 --- /dev/null +++ b/modules/observability_evaluate-project-health-using-scorecards/ref-scorecard-plugin-rest-api-endpoints-and-parameters.adoc @@ -0,0 +1,25 @@ +:_mod-docs-content-type: REFERENCE + +[id="scorecard-plugin-rest-api-endpoints-and-parameters_{context}"] += Scorecard plugin REST API endpoints and parameters + +[role="_abstract"] +REST API endpoints for the scorecard plugin used to fetch portfolio evaluations and component summaries. + +== Supported REST API endpoints +[cols="1,2,1",options="header"] +|=== +|Method and endpoint |Description |Status +|`GET /metrics` |Retrieves all base metrics collected by the plugin environment. |Active +|`GET /aggregations/:aggregationId` |Retrieves calculated summary parameters for a targeted portfolio grouping definition. |Active +|`GET /metrics/:metricId/catalog/aggregations` |Retrieves aggregated summary parameters for a specified entity grouping path. |Deprecated +|=== + +[IMPORTANT] +==== +The endpoint `GET /metrics/:metricId/catalog/aggregations` is deprecated. Update your platform integrations to use the new route path structure: `GET /aggregations/:aggregationId`. +==== + +== API parameter definitions +`aggregationId`:: The unique identification key tracking a targeted scorecard summary layout block. +`metricId`:: The unique provider key tracking an individual metrics collection channel source layer. \ No newline at end of file From 07c740f6c8fff72b5e12959de2a9369adea9d466 Mon Sep 17 00:00:00 2001 From: Tim O'Keefe Date: Mon, 18 May 2026 09:38:16 -0400 Subject: [PATCH 05/11] RHIDP-12524: submitting fixes for CQA faliures --- ...proc-configure-a-default-scorecard-aggregation-card.adoc | 5 ++--- ...ure-an-aggregation-card-with-a-custom-tracking-type.adoc | 6 ++---- .../ref-scorecard-card-configuration-parameters.adoc | 2 +- 3 files changed, 5 insertions(+), 8 deletions(-) diff --git a/modules/observability_evaluate-project-health-using-scorecards/proc-configure-a-default-scorecard-aggregation-card.adoc b/modules/observability_evaluate-project-health-using-scorecards/proc-configure-a-default-scorecard-aggregation-card.adoc index 5ca17d265d9..62dcf895546 100644 --- a/modules/observability_evaluate-project-health-using-scorecards/proc-configure-a-default-scorecard-aggregation-card.adoc +++ b/modules/observability_evaluate-project-health-using-scorecards/proc-configure-a-default-scorecard-aggregation-card.adoc @@ -38,6 +38,5 @@ Add a standard scorecard summary card to your homepage using default, out-of-the . Save the modified configuration file and restart your {product} instance. .Verification -* Access your {roduct-short} homepage interface. - -* Verify that the standard scorecard summary card displays with default metrics. \ No newline at end of file +. Access your {product-short} homepage interface. +. Verify that the standard scorecard summary card displays with default metrics. diff --git a/modules/observability_evaluate-project-health-using-scorecards/proc-configure-an-aggregation-card-with-a-custom-tracking-type.adoc b/modules/observability_evaluate-project-health-using-scorecards/proc-configure-an-aggregation-card-with-a-custom-tracking-type.adoc index 5b613492723..7ac6987ca87 100644 --- a/modules/observability_evaluate-project-health-using-scorecards/proc-configure-an-aggregation-card-with-a-custom-tracking-type.adoc +++ b/modules/observability_evaluate-project-health-using-scorecards/proc-configure-an-aggregation-card-with-a-custom-tracking-type.adoc @@ -59,7 +59,5 @@ where: . Save the modified configuration files and restart your {product} instance. .Verification - -* Access your {product} interface. - -* Verify that the custom scorecard summary card displays with your defined title and calculated values. \ No newline at end of file +. Access your {product-short} homepage interface. +. Verify that the custom scorecard summary card displays with your defined title and calculated values. \ No newline at end of file diff --git a/modules/observability_evaluate-project-health-using-scorecards/ref-scorecard-card-configuration-parameters.adoc b/modules/observability_evaluate-project-health-using-scorecards/ref-scorecard-card-configuration-parameters.adoc index 82d4b01ad65..45ea114d7ef 100644 --- a/modules/observability_evaluate-project-health-using-scorecards/ref-scorecard-card-configuration-parameters.adoc +++ b/modules/observability_evaluate-project-health-using-scorecards/ref-scorecard-card-configuration-parameters.adoc @@ -1,6 +1,6 @@ :_mod-docs-content-type: REFERENCE -[id="ref-scorecard-card-configuration-parameters_{context}"] +[id="scorecard-card-configuration-parameters_{context}"] = Scorecard card configuration parameters [role="_abstract"] From 922520a23e06678133fcf275abdf94e1ef7fd57f Mon Sep 17 00:00:00 2001 From: Tim O'Keefe Date: Mon, 18 May 2026 10:35:10 -0400 Subject: [PATCH 06/11] RHIDP: more additions from dev review --- ...r-collective-health-across-components.adoc | 4 +- ...-with-a-status-grouped-tracking-type.adoc} | 21 ++--- ...on-card-with-an-average-tracking-type.adoc | 78 +++++++++++++++++++ ...orecard-card-configuration-parameters.adoc | 8 +- 4 files changed, 92 insertions(+), 19 deletions(-) rename modules/observability_evaluate-project-health-using-scorecards/{proc-configure-an-aggregation-card-with-a-custom-tracking-type.adoc => proc-configure-an-aggregation-card-with-a-status-grouped-tracking-type.adoc} (58%) create mode 100644 modules/observability_evaluate-project-health-using-scorecards/proc-configure-an-aggregation-card-with-an-average-tracking-type.adoc diff --git a/assemblies/observability_evaluate-project-health-using-scorecards/assembly-monitor-collective-health-across-components.adoc b/assemblies/observability_evaluate-project-health-using-scorecards/assembly-monitor-collective-health-across-components.adoc index 50760f57b41..ac8a5359107 100644 --- a/assemblies/observability_evaluate-project-health-using-scorecards/assembly-monitor-collective-health-across-components.adoc +++ b/assemblies/observability_evaluate-project-health-using-scorecards/assembly-monitor-collective-health-across-components.adoc @@ -16,7 +16,9 @@ include::../modules/observability_evaluate-project-health-using-scorecards/proc- include::../modules/observability_evaluate-project-health-using-scorecards/proc-configure-a-default-scorecard-aggregation-card.adoc[leveloffset=+1] -include::../modules/observability_evaluate-project-health-using-scorecards/proc-configure-an-aggregation-card-with-a-custom-tracking-type.adoc[leveloffset=+1] +include::../modules/observability_evaluate-project-health-using-scorecards/proc-configure-an-aggregation-card-with-a-status-grouped-tracking-type.adoc[leveloffset=+1] + +include::../modules/observability_evaluate-project-health-using-scorecards/proc-configure-an-aggregation-card-with-an-average-tracking-type.adoc[leveloffset=+1] include::../modules/observability_evaluate-project-health-using-scorecards/proc-configure-portfolio-health-on-a-customizable-home-page.adoc[leveloffset=+1] diff --git a/modules/observability_evaluate-project-health-using-scorecards/proc-configure-an-aggregation-card-with-a-custom-tracking-type.adoc b/modules/observability_evaluate-project-health-using-scorecards/proc-configure-an-aggregation-card-with-a-status-grouped-tracking-type.adoc similarity index 58% rename from modules/observability_evaluate-project-health-using-scorecards/proc-configure-an-aggregation-card-with-a-custom-tracking-type.adoc rename to modules/observability_evaluate-project-health-using-scorecards/proc-configure-an-aggregation-card-with-a-status-grouped-tracking-type.adoc index 7ac6987ca87..6c5ec5a8c3b 100644 --- a/modules/observability_evaluate-project-health-using-scorecards/proc-configure-an-aggregation-card-with-a-custom-tracking-type.adoc +++ b/modules/observability_evaluate-project-health-using-scorecards/proc-configure-an-aggregation-card-with-a-status-grouped-tracking-type.adoc @@ -1,21 +1,19 @@ :_mod-docs-content-type: PROCEDURE -[id="configure-an-aggregation-card-with-a-custom-tracking-type_{context}"] -= Configure an aggregation card with a custom tracking type +[id="configure-an-aggregation-card-with-a-status-grouped-tracking-type_{context}"] += Configure an aggregation card with a status-grouped tracking type [role="_abstract"] -Configure a scorecard aggregation card to display status-grouped metric counts or weighted portfolio scores across multiple components. +Configure a scorecard aggregation card to count entities based on status thresholds. .Prerequisites * The scorecard plugin is installed and configured in your {product} instance. -* You have identified the source metric provider and group from the Software Catalog you wish to aggregate. - .Procedure . Open your `app-config.yaml` file. -. Navigate to the `scorecard` section and define your backend Key Performance Indicator (KPI) map within an `aggregationKPIs` block: +. Navigate to the `scorecard` section and define your backend Key Performance Indicator (KPI) map within an `aggregationKPIs` block, setting the tracking type to `statusGrouped`: + [source,yaml] ---- @@ -27,7 +25,6 @@ scorecard: type: statusGrouped metricId: jira.open_issues ---- - . Open your dynamic plugin configuration file. . Reference your custom aggregation ID inside the homepage card properties block under the `home.page/cards` mount point: @@ -47,17 +44,9 @@ scorecard: xs: { w: 12, h: 6 } xxs: { w: 12, h: 6 } ---- -+ -where: -+ -`scorecard.aggregationKPIs`:: Map of KPI keys to KPI definitions. Each key is an aggregation ID. -`title`:: Title shown for the KPI. -`description`:: Short description of the KPI. -`type`:: Aggregation strategy. Use `statusGrouped` for counts per threshold status, or `average` for a weighted portfolio score. -`metricId`:: Metric provider ID. . Save the modified configuration files and restart your {product} instance. .Verification . Access your {product-short} homepage interface. -. Verify that the custom scorecard summary card displays with your defined title and calculated values. \ No newline at end of file +. Verify that the status-grouped scorecard summary card displays with your defined title and calculations. \ No newline at end of file diff --git a/modules/observability_evaluate-project-health-using-scorecards/proc-configure-an-aggregation-card-with-an-average-tracking-type.adoc b/modules/observability_evaluate-project-health-using-scorecards/proc-configure-an-aggregation-card-with-an-average-tracking-type.adoc new file mode 100644 index 00000000000..d129a42c993 --- /dev/null +++ b/modules/observability_evaluate-project-health-using-scorecards/proc-configure-an-aggregation-card-with-an-average-tracking-type.adoc @@ -0,0 +1,78 @@ +:_mod-docs-content-type: PROCEDURE +[id="proc-configure-an-aggregation-card-with-an-average-tracking-type_{context}"] += Configure an aggregation card with an average tracking type + +[role="_abstract"] +Configure a scorecard aggregation card to calculate a single weighted portfolio score across multiple components. + +.Prerequisites +* The scorecard plugin is installed and configured in your Red Hat Developer Hub instance. + +.Procedure + +. Open your `app-config.yaml` file. + +. Navigate to the `scorecard` section and define your backend Key Performance Indicator (KPI) map within an `aggregationKPIs` block, setting the tracking type to `average`. + +. Add the required `statusScores` map to bind numeric weights to your status rules: ++ +[source,yaml] +---- +scorecard: + aggregationKPIs: + portfolio-average-health: + title: "Portfolio Health KPI" + description: "Weighted average score across portfolio components" + type: average + metricId: github.open_prs + options: + statusScores: + success: 100 + warning: 50 + error: 0 +---- + +. Optional: To override the built-in system defaults, add custom threshold parameters using a continuous, gapless number range evaluated on a scale of `0` to `100`: ++ +[source,yaml] +---- + options: + statusScores: + success: 100 + warning: 50 + error: 0 + thresholds: + - max: 39 + status: error + - min: 40 + max: 74 + status: warning + - min: 75 + status: success +---- + +. Open your dynamic plugin configuration file. + +. Reference your average tracking aggregation ID inside the homepage card properties block under the `home.page/cards` mount point: ++ +[source,yaml] +---- +- mountPoint: home.page/cards + importName: ScorecardHomepageCard + config: + props: + aggregationId: "portfolio-average-health" + layouts: + xl: { w: 3, h: 6 } + lg: { w: 4, h: 6 } + md: { w: 6, h: 6 } + sm: { w: 12, h: 6 } + xs: { w: 12, h: 6 } + xxs: { w: 12, h: 6 } +---- + +. Save the modified configuration files and restart your {product} instance. + +.Verification +. Access your {product-short} homepage interface. +. Verify that the weighted average scorecard summary card displays with your custom scores and thresholds. \ No newline at end of file diff --git a/modules/observability_evaluate-project-health-using-scorecards/ref-scorecard-card-configuration-parameters.adoc b/modules/observability_evaluate-project-health-using-scorecards/ref-scorecard-card-configuration-parameters.adoc index 45ea114d7ef..06019988956 100644 --- a/modules/observability_evaluate-project-health-using-scorecards/ref-scorecard-card-configuration-parameters.adoc +++ b/modules/observability_evaluate-project-health-using-scorecards/ref-scorecard-card-configuration-parameters.adoc @@ -21,5 +21,9 @@ Parameters for application settings and dynamic plugin files used to manage home |`title` |The primary textual label rendered on the header block of the homepage card. |`description` |A brief text string summarizing the target scope of the KPI. |`type` |The structural tracking strategy. Specify `statusGrouped` to return independent numerical entity counts per threshold status layer, or specify `average` to calculate a single weighted portfolio score. -|`metricId` |The unique provider identifier mapping to the individual source plugin collection layer, such as `jira.open_issues` or `github.open_prs`. -|=== \ No newline at end of file +|`metricId` |The unique provider identifier mapping to the individual source plugin collection layer. +|=== + +== Options parameters for the `average` tracking type +`options.statusScores`:: Map of threshold status rule keys (`success`, `warning`, `error`) to numeric weight integers. This parameter is required for the `average` type and must be non-empty; missing or empty maps cause application startup failures. +`options.thresholds`:: Optional numeric value array tracking custom status levels evaluated against the `averageScore` output value on a scale from 0 to 100 with one decimal place. If omitted, the system falls back to default values: less than 30 indicates an error, 30 to 79 indicates a warning, and 80 or higher indicates a success. Custom configurations must provide full real-line range coverage with no numeric gaps. From fd75f9606445fefcc56e323e35167195567e1b2d Mon Sep 17 00:00:00 2001 From: Tim O'Keefe Date: Mon, 18 May 2026 11:06:36 -0400 Subject: [PATCH 07/11] RHIDP-12524: had to break assembly because it contained more than 15 items --- ...igure-scorecard-cards-on-the-homepage.adoc | 23 +++++++++++++++++++ ...r-collective-health-across-components.adoc | 10 -------- ...on-card-with-an-average-tracking-type.adoc | 2 +- 3 files changed, 24 insertions(+), 11 deletions(-) create mode 100644 assemblies/observability_evaluate-project-health-using-scorecards/assembly-configure-scorecard-cards-on-the-homepage.adoc diff --git a/assemblies/observability_evaluate-project-health-using-scorecards/assembly-configure-scorecard-cards-on-the-homepage.adoc b/assemblies/observability_evaluate-project-health-using-scorecards/assembly-configure-scorecard-cards-on-the-homepage.adoc new file mode 100644 index 00000000000..8129380e57b --- /dev/null +++ b/assemblies/observability_evaluate-project-health-using-scorecards/assembly-configure-scorecard-cards-on-the-homepage.adoc @@ -0,0 +1,23 @@ +:_mod-docs-content-type: ASSEMBLY +ifdef::context[:parent-context: {context}] + +[id="configure-scorecard-cards-on-the-homepage_{context}"] += Configure scorecard cards on the homepage + +:context: configuring-scorecard-cards-on-the-homepage + +[role="_abstract"] +Scorecard visualization cards on the Red Hat Developer Hub homepage display aggregated metrics to give engineering managers and platform teams immediate visibility into portfolio health trends. + +include::../modules/observability_evaluate-project-health-using-scorecards/proc-configure-a-default-scorecard-aggregation-card.adoc[leveloffset=+1] + +include::../modules/observability_evaluate-project-health-using-scorecards/proc-configure-an-aggregation-card-with-a-status-grouped-tracking-type.adoc[leveloffset=+1] + +include::../modules/observability_evaluate-project-health-using-scorecards/proc-configure-an-aggregation-card-with-an-average-tracking-type.adoc[leveloffset=+1] + +include::../modules/observability_evaluate-project-health-using-scorecards/proc-configure-portfolio-health-on-a-customizable-home-page.adoc[leveloffset=+1] + +include::../modules/observability_evaluate-project-health-using-scorecards/proc-configure-portfolio-health-on-a-read-only-home-page.adoc[leveloffset=+1] + +ifdef::parent-context[:context: {parent-context}] +ifndef::parent-context[:!context:] \ No newline at end of file diff --git a/assemblies/observability_evaluate-project-health-using-scorecards/assembly-monitor-collective-health-across-components.adoc b/assemblies/observability_evaluate-project-health-using-scorecards/assembly-monitor-collective-health-across-components.adoc index ac8a5359107..0f0a1707138 100644 --- a/assemblies/observability_evaluate-project-health-using-scorecards/assembly-monitor-collective-health-across-components.adoc +++ b/assemblies/observability_evaluate-project-health-using-scorecards/assembly-monitor-collective-health-across-components.adoc @@ -14,18 +14,8 @@ include::../modules/observability_evaluate-project-health-using-scorecards/con-a include::../modules/observability_evaluate-project-health-using-scorecards/proc-configure-aggregated-kpis-for-the-scorecard.adoc[leveloffset=+1] -include::../modules/observability_evaluate-project-health-using-scorecards/proc-configure-a-default-scorecard-aggregation-card.adoc[leveloffset=+1] - -include::../modules/observability_evaluate-project-health-using-scorecards/proc-configure-an-aggregation-card-with-a-status-grouped-tracking-type.adoc[leveloffset=+1] - -include::../modules/observability_evaluate-project-health-using-scorecards/proc-configure-an-aggregation-card-with-an-average-tracking-type.adoc[leveloffset=+1] - -include::../modules/observability_evaluate-project-health-using-scorecards/proc-configure-portfolio-health-on-a-customizable-home-page.adoc[leveloffset=+1] - include::../modules/observability_evaluate-project-health-using-scorecards/proc-view-detailed-metrics-from-aggregated-scorecard-kpis.adoc[leveloffset=+1] -include::../modules/observability_evaluate-project-health-using-scorecards/proc-configure-portfolio-health-on-a-read-only-home-page.adoc[leveloffset=+1] - include::../modules/observability_evaluate-project-health-using-scorecards/proc-schedule-metrics-to-avoid-api-limits.adoc[leveloffset=+1] include::../modules/observability_evaluate-project-health-using-scorecards/proc-adjust-metric-retention-to-manage-storage.adoc[leveloffset=+1] diff --git a/modules/observability_evaluate-project-health-using-scorecards/proc-configure-an-aggregation-card-with-an-average-tracking-type.adoc b/modules/observability_evaluate-project-health-using-scorecards/proc-configure-an-aggregation-card-with-an-average-tracking-type.adoc index d129a42c993..afa501c1efb 100644 --- a/modules/observability_evaluate-project-health-using-scorecards/proc-configure-an-aggregation-card-with-an-average-tracking-type.adoc +++ b/modules/observability_evaluate-project-health-using-scorecards/proc-configure-an-aggregation-card-with-an-average-tracking-type.adoc @@ -1,5 +1,5 @@ :_mod-docs-content-type: PROCEDURE -[id="proc-configure-an-aggregation-card-with-an-average-tracking-type_{context}"] +[id="configure-an-aggregation-card-with-an-average-tracking-type_{context}"] = Configure an aggregation card with an average tracking type [role="_abstract"] From 9d99ff089589e2111acffd9a1c4f3d26d022d793 Mon Sep 17 00:00:00 2001 From: Tim O'Keefe Date: Mon, 18 May 2026 11:20:31 -0400 Subject: [PATCH 08/11] RHIDP-12524: updated titles file to include new assembly --- .../assembly-configure-scorecard-cards-on-the-homepage.adoc | 2 +- .../master.adoc | 3 +++ 2 files changed, 4 insertions(+), 1 deletion(-) diff --git a/assemblies/observability_evaluate-project-health-using-scorecards/assembly-configure-scorecard-cards-on-the-homepage.adoc b/assemblies/observability_evaluate-project-health-using-scorecards/assembly-configure-scorecard-cards-on-the-homepage.adoc index 8129380e57b..7959a098694 100644 --- a/assemblies/observability_evaluate-project-health-using-scorecards/assembly-configure-scorecard-cards-on-the-homepage.adoc +++ b/assemblies/observability_evaluate-project-health-using-scorecards/assembly-configure-scorecard-cards-on-the-homepage.adoc @@ -4,7 +4,7 @@ ifdef::context[:parent-context: {context}] [id="configure-scorecard-cards-on-the-homepage_{context}"] = Configure scorecard cards on the homepage -:context: configuring-scorecard-cards-on-the-homepage +:context: configure-scorecard-cards-on-the-homepage [role="_abstract"] Scorecard visualization cards on the Red Hat Developer Hub homepage display aggregated metrics to give engineering managers and platform teams immediate visibility into portfolio health trends. diff --git a/titles/observability_evaluate-project-health-using-scorecards/master.adoc b/titles/observability_evaluate-project-health-using-scorecards/master.adoc index df76be75815..714187e7f46 100644 --- a/titles/observability_evaluate-project-health-using-scorecards/master.adoc +++ b/titles/observability_evaluate-project-health-using-scorecards/master.adoc @@ -27,3 +27,6 @@ include::assemblies/observability_evaluate-project-health-using-scorecards/assem include::modules/observability_evaluate-project-health-using-scorecards/proc-monitor-component-health-and-readiness-with-scorecard-metrics.adoc[leveloffset=+1] include::assemblies/observability_evaluate-project-health-using-scorecards/assembly-monitor-collective-health-across-components.adoc[leveloffset=+1] + +include::assemblies/observability_evaluate-project-health-using-scorecards/assembly-configure-scorecard-cards-on-the-homepage.adoc +.adoc[leveloffset=+1] From 4f90bf28d4a136448bee15cbeacb5055fb9779ed Mon Sep 17 00:00:00 2001 From: Tim O'Keefe Date: Mon, 18 May 2026 11:22:02 -0400 Subject: [PATCH 09/11] RHIDP-12524: minor edit --- .../master.adoc | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/titles/observability_evaluate-project-health-using-scorecards/master.adoc b/titles/observability_evaluate-project-health-using-scorecards/master.adoc index 714187e7f46..f12386002fb 100644 --- a/titles/observability_evaluate-project-health-using-scorecards/master.adoc +++ b/titles/observability_evaluate-project-health-using-scorecards/master.adoc @@ -28,5 +28,4 @@ include::modules/observability_evaluate-project-health-using-scorecards/proc-mon include::assemblies/observability_evaluate-project-health-using-scorecards/assembly-monitor-collective-health-across-components.adoc[leveloffset=+1] -include::assemblies/observability_evaluate-project-health-using-scorecards/assembly-configure-scorecard-cards-on-the-homepage.adoc -.adoc[leveloffset=+1] +include::assemblies/observability_evaluate-project-health-using-scorecards/assembly-configure-scorecard-cards-on-the-homepage.adoc[leveloffset=+1] From c9ed8d93d4663fa8c0d30284182bc04310e4292f Mon Sep 17 00:00:00 2001 From: Tim O'Keefe Date: Mon, 18 May 2026 15:31:54 -0400 Subject: [PATCH 10/11] RHIDP-12524: updated threshold based on dev feebdack --- ...on-card-with-an-average-tracking-type.adoc | 32 +++++++++++-------- 1 file changed, 19 insertions(+), 13 deletions(-) diff --git a/modules/observability_evaluate-project-health-using-scorecards/proc-configure-an-aggregation-card-with-an-average-tracking-type.adoc b/modules/observability_evaluate-project-health-using-scorecards/proc-configure-an-aggregation-card-with-an-average-tracking-type.adoc index afa501c1efb..d6affb5c185 100644 --- a/modules/observability_evaluate-project-health-using-scorecards/proc-configure-an-aggregation-card-with-an-average-tracking-type.adoc +++ b/modules/observability_evaluate-project-health-using-scorecards/proc-configure-an-aggregation-card-with-an-average-tracking-type.adoc @@ -36,19 +36,25 @@ scorecard: + [source,yaml] ---- - options: - statusScores: - success: 100 - warning: 50 - error: 0 - thresholds: - - max: 39 - status: error - - min: 40 - max: 74 - status: warning - - min: 75 - status: success +options: + statusScores: + success: 100 + warning: 50 + error: 0 + thresholds: + rules: + - key: success + expression: '>=80' + color: '#6bb300' + - key: warning + expression: '51-80' + color: 'rgb(224, 189, 108)' + - key: error + expression: '<51' + color: '#be1ec7' + - key: critical + expression: '<10' + color: '#ff0000' ---- . Open your dynamic plugin configuration file. From eff2e50f78f5511ecb394b1320a6c9d4184b4831 Mon Sep 17 00:00:00 2001 From: Tim O'Keefe Date: Mon, 18 May 2026 18:46:04 -0400 Subject: [PATCH 11/11] RHIDP-12524: updated assembly to use attribute --- .../assembly-configure-scorecard-cards-on-the-homepage.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/assemblies/observability_evaluate-project-health-using-scorecards/assembly-configure-scorecard-cards-on-the-homepage.adoc b/assemblies/observability_evaluate-project-health-using-scorecards/assembly-configure-scorecard-cards-on-the-homepage.adoc index 7959a098694..d0b1a6c3e2c 100644 --- a/assemblies/observability_evaluate-project-health-using-scorecards/assembly-configure-scorecard-cards-on-the-homepage.adoc +++ b/assemblies/observability_evaluate-project-health-using-scorecards/assembly-configure-scorecard-cards-on-the-homepage.adoc @@ -7,7 +7,7 @@ ifdef::context[:parent-context: {context}] :context: configure-scorecard-cards-on-the-homepage [role="_abstract"] -Scorecard visualization cards on the Red Hat Developer Hub homepage display aggregated metrics to give engineering managers and platform teams immediate visibility into portfolio health trends. +Scorecard visualization cards on the {product} homepage display aggregated metrics to give engineering managers and platform teams immediate visibility into portfolio health trends. include::../modules/observability_evaluate-project-health-using-scorecards/proc-configure-a-default-scorecard-aggregation-card.adoc[leveloffset=+1]