Review Jira integration troubleshooting docs
What does this MR do?
As per gitlab-org/manage/general-discussion#17634 (comment 1472484675) (creating this so I have something actionable to track)
I'm reviewing the Jira troubleshooting docs to determine if everything is still relevant, can be improved or move things to a more suitable area in our docs.
Section | Notes |
---|---|
GitLab cannot comment on a Jira issue | Still relevant. Added information on how to debug the logs |
GitLab cannot close a Jira issue | Still relevant. Added links to our transition docs. |
CAPTCHA | Probably still relevant |
Jira integration does not work for imported project | This issue is still open. The workaround documented here still seems valid. |
Bulk change all Jira integrations to Jira instance-level values | Code is broken, template column was dropped in !83673 (merged). I have added a variation of the code to work on newer versions, but it needs to be validated. |
Bulk update the service integration password for all projects | Works as advertised (tested the code). Still relevant |
500 We're sorry when accessing a Jira issue in GitLab |
Cannot test this because it would require a paid Jira plan. I have added a link back to Atlassian on how to make the due date visible. |
An error occurred while requesting data from Jira when viewing the Jira issues list in GitLab |
Still relevant (I added this recently) |
Check if Jira Cloud is linked | Moved to the Jira Cloud troubleshooting page since its more appropriate there |
Related issues
Author's checklist
-
Optional. Consider taking the GitLab Technical Writing Fundamentals course. -
Follow the: -
If you're adding or changing the main heading of the page (H1), ensure that the product tier badge is added. -
If you are a GitLab team member, request a review based on: - The documentation page's metadata.
- The associated Technical Writer.
If you are a GitLab team member and only adding documentation, do not add any of the following labels:
~"frontend"
~"backend"
~"type::bug"
~"database"
These labels cause the MR to be added to code verification QA issues.
Reviewer's checklist
Documentation-related MRs should be reviewed by a Technical Writer for a non-blocking review, based on Documentation Guidelines and the Style Guide.
If you aren't sure which tech writer to ask, use roulette or ask in the #docs Slack channel.
-
If the content requires it, ensure the information is reviewed by a subject matter expert. - Technical writer review items:
-
Ensure docs metadata is present and up-to-date. -
Ensure the appropriate labels are added to this MR. -
Ensure a release milestone is set. - If relevant to this MR, ensure content topic type principles are in use, including:
-
The headings should be something you'd do a Google search for. Instead of Default behavior
, say something likeDefault behavior when you close an issue
. -
The headings (other than the page title) should be active. Instead of Configuring GDK
, say something likeConfigure GDK
. -
Any task steps should be written as a numbered list. - If the content still needs to be edited for topic types, you can create a follow-up issue with the docs-technical-debt label.
-
-
-
Review by assigned maintainer, who can always request/require the reviews above. Maintainer's review can occur before or after a technical writer review.
Edited by Anton Smith