Docs feedback: Jira integrations docs confusing
The Jira integrations docs are confusing and need an audit. Observations so far:
-
https://docs.gitlab.com/ee/integration/jira states "Per-project Jira integration" but then the directions linked talk about support for group/namespace levels & more than one project
- https://docs.gitlab.com/ee/integration/jira/development_panel.html also appears to have some inaccuracies about this
- It seems like for Jira integrations to work fully you need both of following setup but that is not clear in docs
- GitLab.com for Jira Cloud app OR Jira DVCS Connector
- Jira development panel integration
-
https://docs.gitlab.com/ee/integration/jira/development_panel.html tone seems to imply you can setup just the panel without DVCS connector yet https://docs.gitlab.com/ee/integration/jira/development_panel.html#configure-gitlab links to "Configure Jira for DVCS" as being required first
- Same with https://docs.gitlab.com/ee/integration/jira. I don't see how panel can work without GitLab.com for Jira Cloud app OR Jira DVCS Connector
- https://docs.gitlab.com/ee/integration/jira/ has a header called "Per-project Jira integration" then in comparison table calls it "Jira integration"
- The follow table currently at https://docs.gitlab.com/ee/integration/jira/development_panel.html#configure-the-integration seems better fit for https://docs.gitlab.com/ee/integration/jira/#per-project-jira-integration
- https://docs.gitlab.com/ee/integration/jira/connect-app.html#install-the-gitlabcom-for-jira-cloud-application-for-self-managed-instances is incomplete. It does not tell user where to download manifest that should then be manually installed or uploaded... the steps appear untested
- Docs or GitLab need to change such that https://docs.gitlab.com/ee/integration/jira/dvcs.html#configure-a-gitlab-application-for-dvcs does not require creation of dedicated
jira
account - Inconsistent capitalization of "Development panel"
- More
!65384 (merged) attempts to address many of these issues but further work beyond what I can do is needed.
Edited by Ben Bodenmiller