Skip to content

Commit 28fd820

Browse files
committed
Ihor's and some minor changeS
1 parent 27a4d8e commit 28fd820

File tree

3 files changed

+4
-11
lines changed

3 files changed

+4
-11
lines changed

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

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,8 @@
44
= Configuring Scorecards to view metrics in your {product} instance
55
:context: assembly-configuring-scorecards-in-rhdh
66

7-
You can configure metrics and scoring capabilities from various data sources for software components in the {product-very-short} catalog.
7+
You can configure one of the following Scorecards in your {product-very-short} instance using metrics and scoring capabilities from various data sources for software components in the {product-very-short} catalog:
88

9-
You can configure either of the following Scorecards in your {product-very-short} instance:
109
* GitHub Scorecards
1110
* Jira Scorecards
1211

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

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55

66
To view project tracking data from Atlassian Jira in your {product-very-short} instance, configure Jira Scorecards.
77
The following Jira versions are supported:
8+
89
* Jira Cloud: API version 3
910
* Jira Data Center: API version 2
1011

@@ -19,13 +20,13 @@ The following Jira versions are supported:
1920
== Procedure
2021

2122
. Create a Jira configuration token using one of the following methods, depending on your Jira product:
22-
** Jira Cloud: Create a personal token. You must then create a `Base64-encoded` string using the following plain text format: `your-atlassian-email:your-jira-api-token`.
23+
** Jira Cloud: https://id.atlassian.com/manage-profile/security/api-tokens[Create a personal token]. You must then create a `Base64-encoded` string using the following plain text format: `your-atlassian-email:your-jira-api-token`.
2324
+
2425
[source,bash]
2526
----
2627
echo -n 'your-atlassian-email:your-jira-api-token' | base64
2728
----
28-
** Jira datacenter: Create and use a Personal Access Token (PAT) in your Jira datacenter account.
29+
** Jira datacenter: Create and use a Personal Access Token (PAT) in your Jira datacenter account. For more information, see the https://confluence.atlassian.com/enterprise/using-personal-access-tokens-1026032365.html[Atlassian] documentation.
2930

3031
. Configure the Jira Scorecard plugin in your `{product-very-short} dynamic-plugins-config.yaml` using either a direct setup or a proxy setup.
3132
.. Use a direct setup (Recommended for simpler environments): Add the following code to your `{product-very-short} dynamic-plugins-config.yaml`:
@@ -41,7 +42,6 @@ plugins:
4142
token: ${JIRA_TOKEN}
4243
product: datacenter # Change to 'cloud' if using Jira Cloud
4344
----
44-
+
4545
where:
4646
`baseUrl`:: Enter the Jira URL.
4747
`token`:: Enter the Jira token (Base64 string for Cloud, PAT for Data Center).
@@ -101,9 +101,7 @@ spec:
101101
system: examples
102102
providesApis: [example-grpc-api]
103103
----
104-
105104
where:
106-
107105
`jira/project-key`:: Required: Enter the Jira project key.
108106
`jira/component`:: Optional: Enter the Jira component name.
109107
`jira/label`:: Optional: Enter the Jira label.
@@ -141,9 +139,7 @@ scorecard:
141139
mandatoryFilter: Type = Task AND Resolution = Resolved
142140
customFilter: priority in ("Critical", "Blocker")
143141
----
144-
145142
where:
146-
147143
`mandatoryFilter`:: Optional: Replaces the default filter (`type = Bug and resolution = Unresolved`).
148144
`customFilter`:: Optional: Specifies a global custom filter. The entity annotation `jira/custom-filter` overrides this value.
149145

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

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,6 @@
33
[id="ref-override-rules-to-configure-entity-specific-thresholds_{context}"]
44
= Threshold rules to metrics for your Scorecard plugin
55

6-
:_mod-docs-content-type: CONCEPT
7-
86
You can override individual threshold rules for a specific component by using annotations in its `catalog-info.yaml` file. These annotations are merged with the existing global rules defined in your `{product-very-short} app-config.yaml` file.
97

108
.Annotation Format Reference

0 commit comments

Comments
 (0)