Skip to content

Commit 0d2b4f2

Browse files
committed
Incorporated some of the test day comments
1 parent ebc1554 commit 0d2b4f2

6 files changed

+7
-7
lines changed
File renamed without changes.

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ If rules are ordered incorrectly, a less restrictive rule can prevent stricter r
1919
=== Correct Ordering Example
2020

2121
Order the rules from the most restrictive value range to the least restrictive to ensure logical flow.
22-
+
22+
2323
[source,yaml]
2424
----
2525
# Correct Example: Order from most restrictive (Success) to least restrictive (Error)

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ To override the default thresholds set by a metric provider, you must update you
88
The custom configuration completely replaces the provider's defaults. If you omit a threshold category (such as `success`), that category is not assigned.
99

1010
The following configuration defines a `success` threshold as 10 or fewer issues, which applies to all components using the `jira.open_issues` metric unless explicitly overridden by an entity annotation.
11-
+
11+
1212
[source,yaml]
1313
----
1414
scorecard:

modules/observe/scorecards/con-understand-scorecard-plugins.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,4 +7,4 @@ include::{docdir}/artifacts/snip-developer-preview.adoc[]
77

88
The Scorecard plugin offers comprehensive, customizable insights into the health, security posture, and compliance of your components, services, and APIs. It centralizes Key Performance Indicators (KPIs) within {product} ({product-very-short}), so you do not have to consult multiple external systems.
99

10-
image::rhdh/scorecard-sample.png[]
10+
image::rhdh/scorecard-sample.png[]

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -39,13 +39,13 @@ plugins:
3939
jira:
4040
baseUrl: ${JIRA_BASE_URL}
4141
token: ${JIRA_TOKEN}
42-
product: datacenter # Change to 'cloud' if using Jira Cloud
42+
product: _<jira_product>_
4343
----
4444
where:
4545

4646
`baseUrl`:: Enter the Jira URL.
4747
`token`:: Enter the Jira token (Base64 string for Cloud, PAT for Data Center). The Jira token must be added as a secret file in your {configuring-book-link}#provisioning-your-custom-configuration[`{product} app-config.yaml` file].
48-
`product`:: Enter the supported product: `cloud` or `datacenter`.
48+
`product`:: Enter the supported product: `cloud` or `datacenter`. (`cloud` is the preferred option)
4949

5050
.. Use a proxy setup: In your `{product-very-short} dynamic-plugins-config.yaml`, add the following code:
5151
+

modules/observe/scorecards/ref-override-rules-to-configure-entity-specific-thresholds.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ You can override individual threshold rules for a specific component by using an
99

1010
The annotation key follows a strict structure:
1111
`scorecard.io/{providerId}.thresholds.rules.{thresholdKey}: '{expression}'`
12-
+
12+
1313
[cols="1,2,2,2", options="header"]
1414
|===
1515
| Element | Description | Example Annotation | Example Value
@@ -33,7 +33,7 @@ The annotation key follows a strict structure:
3333
.Example: Entity Annotation Override
3434

3535
The following example describes the entity overriding only the `warning` and `error` rules for the `jira.open_issues` metric. The `success` rule falls back to the value defined in the global `{product-very-short} app-config.yaml` file.
36-
+
36+
3737
[source,yaml]
3838
----
3939
# catalog-info.yaml

0 commit comments

Comments
 (0)