This is an automated email from the ASF dual-hosted git repository.
zky pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/incubator-devlake-website.git
The following commit(s) were added to refs/heads/main by this push:
new c477bb495a docs: updated Jira configuration images and text (#499)
c477bb495a is described below
commit c477bb495aa56c4aed385e52e743ebd003eae683
Author: Yumeng Wang <[email protected]>
AuthorDate: Wed Apr 26 18:20:26 2023 +0800
docs: updated Jira configuration images and text (#499)
* docs: updated Jira configuration images and text
* docs: rearanged titles for Jira config
---
docs/Configuration/Jira.md | 82 +++++++++++++--------
.../images/jira-create-a-connection.png | Bin 0 -> 251873 bytes
docs/Configuration/images/jira-set-data-scope.png | Bin 0 -> 145731 bytes
.../images/jira-set-transformation1.png | Bin 0 -> 88605 bytes
.../images/jira-set-transformation2.png | Bin 0 -> 246495 bytes
.../images/jira-set-transformation3.png | Bin 0 -> 63077 bytes
6 files changed, 51 insertions(+), 31 deletions(-)
diff --git a/docs/Configuration/Jira.md b/docs/Configuration/Jira.md
index 099063172f..7b1cb4b4e5 100644
--- a/docs/Configuration/Jira.md
+++ b/docs/Configuration/Jira.md
@@ -4,52 +4,69 @@ sidebar_position: 4
description: Config UI instruction for Jira
---
-Visit config-ui: `http://localhost:4000`.
+Visit Config UI at: `http://localhost:4000`.
-### Step 1 - Add Data Connections
+## Step 1 - Add Data Connections
-
+
-#### Connection Name
+### Connection Name
-Name your connection.
+Give your connection a unique name to help you identify it in the future.
+### Jira Version
+Select if you use Jira Cloud or Jira Server.
+
+### Jira Cloud
#### Endpoint URL
+This should be a valid REST API endpoint:
`https://<mydomain>.atlassian.net/rest/`
+
+Please note: the endpoint url should end with `/`.
-This should be a valid REST API endpoint
+#### E-mail
+Please enter the e-mail of your Jira account.
-- If you are using Jira Cloud, the endpoint will be
`https://<mydomain>.atlassian.net/rest/`
-- If you are self-hosting Jira v7+ or v8+, the endpoint may look like
`https://jira.<mydomain>.com/rest/`
- The endpoint url should end with `/`.
+#### API Token
+Learn about [how to create an API
token](https://support.atlassian.com/atlassian-account/docs/manage-api-tokens-for-your-atlassian-account/).
-#### Username / Email
+Please note: Jira API token and Personal Access Token are two different tokens.
-Input the username or email of your Jira account.
+### Jira Server
+#### Endpoint URL
+This should be a valid REST API endpoint: `https://jira.<mydomain>.com/rest/`
-#### Password
+Please note: the endpoint url should end with `/`.
-- If you are using Jira Cloud, please input the [Jira personal access
token](https://confluence.atlassian.com/enterprise/using-personal-access-tokens-1026032365.html).
-- If you are using Jira Server v7+ or v8+, please input the password of your
Jira account.
+#### Authentication Method
+Jira Server supports two ways of authentication: using basic authentication or
Personal Access Token.
-#### Auth Token
+#### Username
+Please enter the username of your Jira account.
-When accessing Jira API using a Jira Auth Token, users may encounter access
restrictions if their token does not have sufficient permissions. This is
typically caused by insufficient scope or role settings for the Jira Auth Token.
+#### Password
+Please enter the password of your Jira account.
+
+#### Personal Access Token
+Learn about [how to create a Personal Access
Token](https://confluence.atlassian.com/enterprise/using-personal-access-tokens-1026032365.html).
+
+### Token Permissions
+For both Jira Cloud and Jira Server, when accessing Jira API, users may
encounter access restrictions if their token does not have sufficient
permissions. This is typically caused by insufficient scope or role settings
for the Jira token.
To solve this issue, users can take the following steps:
- Checking User Permissions
-Users can confirm whether they have sufficient permissions by checking their
permissions in Jira. For cloud users, they can view their global and project
permissions through the "Permissions" tab on the "Profile" page. For server
users, they can log in to Jira as an administrator and view user permissions on
the "User Management" page.
+Users can confirm whether they have sufficient permissions by checking their
permissions in Jira. For Cloud users, they can view their global and project
permissions through the "Permissions" tab on the "Profile" page. For Server
users, they can log in to Jira as an administrator and view user permissions on
the "User Management" page.
- Ensuring Sufficient Permissions
-Before using Jira API, users need to ensure that their account has at least
the necessary project or global permissions. Global permissions include various
Jira system settings and management operations, while project permissions
control specific operations and configurations for each Jira project. Users can
assign roles such as `Project Administrator`, `Project Lead`, `Developer`, etc.
for the corresponding projects, or assign global permissions such as `Jira
Administrators`, `Jira Soft [...]
+Before using the Jira API, users need to ensure that their account has at
least the necessary project or global permissions. Global permissions include
various Jira system settings and management operations, while project
permissions control specific operations and configurations for each Jira
project. Users can assign roles such as `Project Administrator`, `Project
Lead`, `Developer`, etc. for the corresponding projects, or assign global
permissions such as `Jira Administrators`, `Jira [...]
- Solving Access Restrictions
-To solve access restrictions caused by insufficient Jira Auth Token
permissions, users should check the token's permission settings to ensure the
correct scope and role are set. If the permission settings are correct but the
required API is still inaccessible, consider using other authentication
methods, such as authenticating with a username and password. If the issue
persists, contact the Jira administrator for further assistance.
+To solve access restrictions caused by insufficient Jira token permissions,
users should check the token's permission settings to ensure the correct scope
and role are set. If the permission settings are correct but the required API
is still inaccessible, consider using other authentication methods, such as
authenticating with a username and password. If the issue persists, contact the
Jira administrator for further assistance.
-#### Proxy URL (Optional)
+### Proxy URL (Optional)
If you are behind a corporate firewall or VPN you may need to utilize a proxy
server. Enter a valid proxy server address on your network, e.g.
`http://your-proxy-server.com:1080`
@@ -59,36 +76,39 @@ DevLake uses a dynamic rate limit to collect Jira data. You
can adjust the rate
Jira(Cloud) uses a dynamic rate limit and has no clear rate limit. For Jira
Server's rate limiting, please contact your Jira Server admin to [get or set
the maximum rate
limit](https://repository.prace-ri.eu/git/help/security/rate_limits.md) of your
Jira instance. Please do not use a rate that exceeds this number.
-#### Test and Save Connection
+### Test and Save Connection
Click `Test Connection`, if the connection is successful, click `Save
Connection` to add the connection.
-### Step 2 - Setting Data Scope
+## Step 2 - Setting Data Scope
-
+
-#### Projects
+### Boards
Choose the Jira boards to collect.
-#### Data Entities
+### Data Entities
Usually, you don't have to modify this part. However, if you don't want to
collect certain Jira entities, you can unselect some entities to accerlerate
the collection speed.
- Issue Tracking: Jira issues, issue comments, issue labels, etc.
- Cross Domain: Jira accounts, etc.
-### Step 3 - Adding Transformation Rules (Optional)
+## Step 3 - Adding Transformation Rules (Optional)
+Adding transforamtion to the Jira data you wish to collect can help
standardize the data to view more metrics, such as [Requirement Lead
Time](https://devlake.apache.org/docs/Metrics/RequirementLeadTime), [Bug
Age](https://devlake.apache.org/docs/Metrics/BugAge) and DORA - [Median Time to
Restore Service](https://devlake.apache.org/docs/Metrics/MTTR).
+
+
+
+
-
Without adding transformation rules, you can not view all charts in "Jira" or
"Engineering Throughput and Cycle Time" dashboards.<br/>
Each Jira board has at most ONE set of transformation rules.
-
-#### Issue Tracking
+### Issue Tracking
- Requirement: choose the issue types to be transformed to "REQUIREMENT".
- Bug: choose the issue types to be transformed to "BUG".
@@ -96,11 +116,11 @@ Each Jira board has at most ONE set of transformation
rules.
- Epic Key: choose the custom field that represents Epic key. In most cases,
it is "Epic Link".
- Story Point: choose the custom field that represents story points. In most
cases, it is "Story Points".
-#### Additional Settings
+### Additional Settings
- Remotelink Commit SHA: parse the commits from an issue's remote links by the
given regular expression so that the relationship between `issues` and
`commits` can be created. You can directly use the regular expression
`/commit/([0-9a-f]{40})$`.
-### Step 4 - Setting Sync Frequency
+## Step 4 - Setting Sync Frequency
You can choose how often you would like to sync your data in this step by
selecting a sync frequency option or enter a cron code to specify your prefered
schedule.
diff --git a/docs/Configuration/images/jira-create-a-connection.png
b/docs/Configuration/images/jira-create-a-connection.png
new file mode 100644
index 0000000000..68fb73bc6b
Binary files /dev/null and
b/docs/Configuration/images/jira-create-a-connection.png differ
diff --git a/docs/Configuration/images/jira-set-data-scope.png
b/docs/Configuration/images/jira-set-data-scope.png
new file mode 100644
index 0000000000..27dd8b1edb
Binary files /dev/null and b/docs/Configuration/images/jira-set-data-scope.png
differ
diff --git a/docs/Configuration/images/jira-set-transformation1.png
b/docs/Configuration/images/jira-set-transformation1.png
new file mode 100644
index 0000000000..b0e4804368
Binary files /dev/null and
b/docs/Configuration/images/jira-set-transformation1.png differ
diff --git a/docs/Configuration/images/jira-set-transformation2.png
b/docs/Configuration/images/jira-set-transformation2.png
new file mode 100644
index 0000000000..3e43beaa92
Binary files /dev/null and
b/docs/Configuration/images/jira-set-transformation2.png differ
diff --git a/docs/Configuration/images/jira-set-transformation3.png
b/docs/Configuration/images/jira-set-transformation3.png
new file mode 100644
index 0000000000..bbfd891fba
Binary files /dev/null and
b/docs/Configuration/images/jira-set-transformation3.png differ
