You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@devlake.apache.org by "abeizn (via GitHub)" <gi...@apache.org> on 2023/03/24 02:55:35 UTC
[GitHub] [incubator-devlake-website] abeizn opened a new pull request, #476: docs: jira auth token
abeizn opened a new pull request, #476:
URL: https://github.com/apache/incubator-devlake-website/pull/476
### ⚠️ Pre Checklist
> Please complete _ALL_ items in this checklist, and remove before submitting
- [ ] I have `npm run build` and `npm run serve` locally before submitting this PR
- [ ] I have read through the [Contributing](https://devlake.apache.org/community/) Documentation
# Summary
jira add auth token docs
### Does this close any open issues?
NA
### Screenshots
### Other Information
Any other information that is important to this PR.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@devlake.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [incubator-devlake-website] Startrekzky merged pull request #476: docs: jira auth token
Posted by "Startrekzky (via GitHub)" <gi...@apache.org>.
Startrekzky merged PR #476:
URL: https://github.com/apache/incubator-devlake-website/pull/476
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@devlake.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [incubator-devlake-website] Startrekzky commented on a diff in pull request #476: docs: jira auth token
Posted by "Startrekzky (via GitHub)" <gi...@apache.org>.
Startrekzky commented on code in PR #476:
URL: https://github.com/apache/incubator-devlake-website/pull/476#discussion_r1147667051
##########
docs/Configuration/Jira.md:
##########
@@ -7,25 +7,44 @@ description: Config UI instruction for Jira
Visit config-ui: `http://localhost:4000`.
### Step 1 - Add Data Connections
+
#### Connection Name
+
Name your connection.
#### Endpoint URL
+
This should be a valid REST API endpoint
- - 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 `/`.
+
+- 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 `/`.
#### Username / Email
+
Input the username or email of your Jira account.
#### Password
+
- 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.
+#### Auth Token
+
+When users access Jira API using Jira Auth Token, they 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.
+
+To solve this issue, you can try the following:
+
+- First, check if your Jira Auth Token has sufficient permissions, including the required scope and role. You can set these when creating the token, and incorrect settings will result in restricted access.
Review Comment:
The problem here is that users don't know how to tell if a Jira Auth Token is insufficient for DevLake until they start running pipelines.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@devlake.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org