Skip to content

Commit 2879618

Browse files
committed
Incorporated Shipra's comments
1 parent 844cec0 commit 2879618

File tree

4 files changed

+11
-7
lines changed

4 files changed

+11
-7
lines changed

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,16 +9,16 @@ Threshold rule evaluation is order-dependent. You must follow logical ordering t
99

1010
Rules must be sequenced logically. Order rules from the most strict (smallest range) to the least strict (largest range) or ensure all ranges are mutually exclusive.
1111

12-
=== Problematic Rule Order Example
12+
=== Problematic rule order example
1313

1414
If rules are ordered incorrectly, a less restrictive rule can prevent stricter rules from being evaluated:
1515

1616
. `warning: <50`: Any value less than 50 triggers the warning rule and stops evaluation.
17-
. `success: <10`: This rule is not evaluated because all values less than 10 already matched the preceding warning rule.
17+
. `success: <10`: This rule is not evaluated because all values less than 10 have already matched the preceding warning rule.
1818

19-
=== Correct Ordering Example
19+
=== Correct ordering example
2020

21-
Order the rules from the most restrictive value range to the least restrictive to ensure logical flow.
21+
Order the rules from the most restrictive value range to the least restrictive to ensure a logical flow.
2222

2323
[source,yaml]
2424
----

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -112,6 +112,7 @@ scorecard:
112112
- key: error
113113
expression: '>50'
114114
----
115+
+
115116
where:
116117

117118
`scorecard:plugins:github:open_prs:thresholds`:: Lists the default threshold values for the GitHub open PRs metric.

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

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -87,6 +87,7 @@ jira:
8787
proxyPath: /jira/api
8888
product: cloud # Change to 'datacenter' if using Jira Datacenter
8989
----
90+
+
9091
where:
9192

9293
`target`:: The base URL of your Jira instance, configured under ${JIRA_BASE_URL} in your {product-very-short} secrets.
@@ -116,6 +117,7 @@ spec:
116117
system: examples
117118
providesApis: [example-grpc-api]
118119
----
120+
+
119121
where:
120122

121123
`jira/project-key`:: Required: Enter the Jira project key.
@@ -152,12 +154,12 @@ scorecard:
152154
- key: error
153155
expression: '>50'
154156
----
157+
+
155158
where:
156159

157160
`scorecard:plugins:jira:open_issues:thresholds`:: Lists the default threshold values for the Jira open Issues metric.
158161

159-
. (Optional) Define global or custom mandatory filters.
160-
.. You can apply global mandatory filters or define custom filters that entities can override. Add the following to your {product-very-short} `{my-app-config-file}`:
162+
. (Optional) Define global or custom mandatory filters that entities can override by adding the following code to your {product-very-short} `{my-app-config-file}` file:
161163
+
162164
[source,yaml]
163165
----
@@ -169,6 +171,7 @@ scorecard:
169171
mandatoryFilter: Type = Task AND Resolution = Unresolved
170172
customFilter: priority in ("Critical", "Blocker")
171173
----
174+
+
172175
where:
173176

174177
`mandatoryFilter`:: Optional: Replaces the default filter (`type = Bug and resolution = Unresolved`).

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ You must manually install and enable the plugin in your {product} instance.
1111

1212
.Procedure
1313

14-
* Add the following configuration in your `{product} dynamic-plugin-config.yaml` file:
14+
* Add the following configuration in your {product-very-short} `dynamic-plugin-config.yaml` file:
1515
+
1616
[source,yaml]
1717
----

0 commit comments

Comments
 (0)