Restructure GitLab<->Jira integration docs
The structure and content of documentation on integration between GitLab and Jira needs to be improved. Current issues include: - The integration options are not clearly explained. Currently, two options are available. A third option is in development, but outside the scope of this epic. - Issue: It's difficult for customers to know which option would meet their needs. - The behaviour of both options is not described in full. One is an addition to GitLab, while the other is an addition to Jira. - Issue: Customers may not gain maximum benefit from the integration, because they don't fully understand how they each work. This lack of understanding may result in integration problems, and wasted time spent troubleshooting. - The GitLab<->Jira development panel integration is documented, but not linked from any of the integration master pages. https://docs.gitlab.com/ee/integration/jira_development_panel.html#gitlab-jira-development-panel-integration-premium - Issue: Customers may not be aware of this option, because it's not linked from the lists of available integration options. - Transition IDs are not fully explained or described. - Issue: Transition IDs are integral to correct operation of Jira's Smart Commits feature, which allows issues to be transitioned from one state to another. The proposal is to create individual documentation issues which can be completed independently of each other. The structure I'm proposing is as follows: * Introduction and overview of GitLab <-> Jira integration - Perhaps include a table to illustrate the features provided by each option * For each integration method: - Prerequisites - Installation and configuration procedure - Integration examples - Troubleshooting (if required)
epic