RHIDP-8709: Scorecard plugin #1465

pabel-rh · 2025-10-29T09:44:18Z

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

Version(s):
1.8, main
Issue:
RHIDP-8709
Preview:
https://redhat-developer.github.io/red-hat-developers-documentation-rhdh/pr-1465/scorecard-plugin/

rhdh-bot · 2025-10-29T09:46:52Z

Updated preview: https://redhat-developer.github.io/red-hat-developers-documentation-rhdh/pr-1465/ @ 11/04/25 13:32:44

assemblies/assembly-configuring-scorecards-in-rhdh.adoc

modules/observe/scorecards/proc-configuring-jira-scorecards-in-rhdh-instance.adoc

modules/observe/scorecards/proc-authenticating-and-managing-scorecard-plugins.adoc

modules/observe/scorecards/proc-installing-scorecard-plugin-in-rhdh-instance.adoc

modules/observe/scorecards/proc-configuring-github-scorecards-in-rhdh-instance.adoc

modules/observe/scorecards/proc-configuring-jira-scorecards-in-rhdh-instance.adoc

modules/observe/scorecards/proc-installing-scorecard-plugin-in-rhdh-instance.adoc

modules/observe/scorecards/proc-configuring-jira-scorecards-in-rhdh-instance.adoc

modules/observe/scorecards/proc-configuring-github-scorecards-in-rhdh-instance.adoc

modules/observe/scorecards/con-best-practices-for-threshold-rules.adoc

dzemanov · 2025-10-30T10:41:50Z

Thank you @pabel-rh for the PR, I have requested some changes but we are almost there.
I think it would also be good to add 1 screenshot of how scorecards look like. You can screenshot some from feature demo or you can use this one:

modules/observe/scorecards/con-set-global-standards-for-metric-thresholds.adoc

modules/observe/scorecards/con-best-practices-for-threshold-rules.adoc

modules/observe/scorecards/proc-configuring-jira-scorecards-in-rhdh-instance.adoc

modules/observe/scorecards/proc-authenticating-and-managing-scorecard-plugins.adoc

modules/observe/scorecards/con-best-practices-for-threshold-rules.adoc

modules/observe/scorecards/proc-configuring-github-scorecards-in-rhdh-instance.adoc

modules/observe/scorecards/proc-configuring-jira-scorecards-in-rhdh-instance.adoc

modules/observe/scorecards/proc-installing-scorecard-plugin-in-rhdh-instance.adoc

assemblies/assembly-configuring-scorecards-in-rhdh.adoc

modules/observe/scorecards/proc-configuring-github-scorecards-in-rhdh-instance.adoc

modules/observe/scorecards/proc-configuring-jira-scorecards-in-rhdh-instance.adoc

modules/observe/scorecards/con-best-practices-for-threshold-rules.adoc

shipsing · 2025-11-04T10:19:27Z

modules/observe/scorecards/con-best-practices-for-threshold-rules.adoc

+:_mod-docs-content-type: CONCEPT
+
+[id="con-best-practices-for-threshold-rules"]
+= Best practices for threshold rules


What are threshold rules? have we defined it anywhere?

Yes, Shipra. This topic appears after the definition. Adding an image of the doc preview from GitHub:

modules/observe/scorecards/con-best-practices-for-threshold-rules.adoc

modules/observe/scorecards/proc-configuring-jira-scorecards-in-rhdh-instance.adoc

shipsing · 2025-11-04T12:55:57Z

modules/observe/scorecards/proc-installing-scorecard-plugin-in-rhdh-instance.adoc

+[id="proc-installing-scorecard-plugin-in-rhdh-instance_{context}"]
+= Installing the Scorecard plugin in your {product} instance
+
+You must manually install and enable the plugin in your {product} instance.


Why users would need to perform this procedure? What's the benefit?

This is like a whole module. So, its benefits and all are mentioned in the conceptual topics in the beginning of this assembly. Adding a screenshot of the above concept:

modules/observe/scorecards/proc-installing-scorecard-plugin-in-rhdh-instance.adoc

shipsing · 2025-11-04T12:59:10Z

modules/observe/scorecards/proc-viewing-scorecards-in-rhdh.adoc

+[id="proc-viewing-scorecards-in-rhdh_{context}"]
+= Viewing Scorecard metrics in {product}
+
+As a developer, you can view the GitHub and Jira metrics using the *Scorecards* in your {product-very-short} instance.


Why users would need to perform this procedure? What's the benefit?

This is mentioned in the main module on top. These procedures are a subset of the main module which explains why this is beneficial.

shipsing · 2025-11-04T13:01:04Z

modules/observe/scorecards/proc-viewing-scorecards-in-rhdh.adoc

+. In your {product-very-short} navigation menu, go to *Catalog*.
+. Select the software component (catalog entity) that has Scorecard metrics configured.
+. On the component *Service* page, go to the **Scorecard** tab.
+. To view the desired metrics, select the corresponding tile.


Can we add a screenshot here for reference?

We have a screenshot reference right at the top during the explanation, Shipra..
Adding image:

pabel-rh temporarily deployed to external October 29, 2025 09:44 — with GitHub Actions Inactive

pabel-rh added Peer review needed 📖 do-no-merge/review-in-progress 👀 Technical review needed 🔩 Test all the procedures labels Oct 29, 2025

pabel-rh temporarily deployed to external October 29, 2025 13:47 — with GitHub Actions Inactive

imykhno reviewed Oct 29, 2025

View reviewed changes

pabel-rh temporarily deployed to external October 30, 2025 05:41 — with GitHub Actions Inactive

pabel-rh requested a review from imykhno October 30, 2025 05:41

pabel-rh temporarily deployed to external October 30, 2025 06:18 — with GitHub Actions Inactive

dzemanov requested changes Oct 30, 2025

View reviewed changes

modules/observe/scorecards/proc-authenticating-and-managing-scorecard-plugins.adoc Outdated Show resolved Hide resolved

dzemanov requested changes Oct 30, 2025

View reviewed changes

modules/observe/scorecards/proc-installing-scorecard-plugin-in-rhdh-instance.adoc Outdated Show resolved Hide resolved

dzemanov requested changes Oct 30, 2025

View reviewed changes

modules/observe/scorecards/con-best-practices-for-threshold-rules.adoc Outdated Show resolved Hide resolved

pabel-rh force-pushed the rhidp-8709 branch from 1af64d8 to 846a104 Compare October 30, 2025 15:02

pabel-rh temporarily deployed to external October 30, 2025 15:03 — with GitHub Actions Inactive

pabel-rh temporarily deployed to external October 30, 2025 15:58 — with GitHub Actions Inactive

pabel-rh requested a review from dzemanov October 30, 2025 16:02

dzemanov requested changes Oct 30, 2025

View reviewed changes

pabel-rh force-pushed the rhidp-8709 branch from 4216b1f to b379a2f Compare October 30, 2025 17:06

pabel-rh temporarily deployed to external October 30, 2025 17:06 — with GitHub Actions Inactive

pabel-rh requested a review from dzemanov October 30, 2025 17:07

dzemanov reviewed Oct 30, 2025

View reviewed changes

modules/observe/scorecards/con-best-practices-for-threshold-rules.adoc Outdated Show resolved Hide resolved

dzemanov approved these changes Oct 30, 2025

View reviewed changes

imykhno approved these changes Oct 30, 2025

View reviewed changes

pabel-rh temporarily deployed to external October 30, 2025 17:27 — with GitHub Actions Inactive

pabel-rh added Technical review done ⛅ Any procedure has been succesfully tested and removed Technical review needed 🔩 Test all the procedures labels Oct 30, 2025

dzemanov requested changes Oct 31, 2025

View reviewed changes

pabel-rh temporarily deployed to external November 3, 2025 15:04 — with GitHub Actions Inactive

pabel-rh added Technical review needed 🔩 Test all the procedures and removed Technical review done ⛅ Any procedure has been succesfully tested labels Nov 3, 2025

dzemanov requested changes Nov 3, 2025

View reviewed changes

modules/observe/scorecards/proc-configuring-jira-scorecards-in-rhdh-instance.adoc Outdated Show resolved Hide resolved

pabel-rh force-pushed the rhidp-8709 branch from fd3b987 to 9f58ac8 Compare November 4, 2025 05:08

pabel-rh temporarily deployed to external November 4, 2025 05:08 — with GitHub Actions Inactive

pabel-rh requested a review from dzemanov November 4, 2025 05:12

dzemanov approved these changes Nov 4, 2025

View reviewed changes

pabel-rh added Technical review done ⛅ Any procedure has been succesfully tested and removed Technical review needed 🔩 Test all the procedures labels Nov 4, 2025

shipsing reviewed Nov 4, 2025

View reviewed changes

pabel-rh added 16 commits November 4, 2025 18:42

Scorecard plugin

23e0408

Incorporated tech changes

396399b

Ihor's and some minor changeS

4e68e9e

Updated Abstract

58515f5

Dominika's comments - some of them

77fbb66

Incorporated Dominika's comments and added images

83826b7

Dominika's comments

1d6e535

Minor changes

1a3eb8e

Incorporated Dominika's comments and rebased branch

40efa8e

Incorporated some of the test day comments

40f5bcb

Fixing build issue

783e427

Test day updates

9011c46

Test day updates

17117b1

test day minor change

8ce8b09

Incorporated Dominika's comments

844cec0

Incorporated Shipra's comments

2879618

pabel-rh force-pushed the rhidp-8709 branch from 9f58ac8 to 2879618 Compare November 4, 2025 13:30

pabel-rh temporarily deployed to external November 4, 2025 13:30 — with GitHub Actions Inactive

RHIDP-8709: Scorecard plugin #1465

Are you sure you want to change the base?

RHIDP-8709: Scorecard plugin #1465

Uh oh!

Conversation

pabel-rh commented Oct 29, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

rhdh-bot commented Oct 29, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

dzemanov commented Oct 30, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

pabel-rh commented Oct 29, 2025 •

edited

Loading

rhdh-bot commented Oct 29, 2025 •

edited

Loading