Skip to content

Create plan to combine Jira pages

We have the following pages:

4 in user/project/integrations and 1 in integration. That's not good.

Where we are

In #300312 (closed), @sselhorn identified https://docs.gitlab.com/ee/user/project/integrations/jira.html as one of the top 20 pages needing revisions to adhere to CTRT. Unbeknownst to Suzanne, Amy was considering changes to the very same page: she had placed #268278 (closed) (Document usage of Jira Connect application with self-hosted GitLab) in her %13.10 milestone, and it had come up again in #323644 (closed). As PM for ~"group::ecosystem", this work is one of @deuley's highest priorities.

Amy realized, in a panic, that #268278 (closed) was theoretically about restructuring one page, but the truth likely involved all five, and she needed the help of another party to help craft a plan for tackling this work all at once.

Where we need to go

As Amy and Suzanne discussed in team chat, step 1 is to capture all the subheadings on these pages, so they can...

  1. Understand what's there
  2. Create a well-organized new section, likely at doc/integration/jira/, to house all of the GitLab / Jira connection information
  3. Structure the new pages in a thoughtful way that supports future expansion in as-yet-unknown directions
  4. ???
  5. Profit

Subheading structure

Current

https://docs.gitlab.com/ee/integration/jira_development_panel.html contains:

# GitLab Jira Development Panel integration **(FREE)**
## Features
## Configuration
### Jira DVCS configuration
#### GitLab account configuration for DVCS
#### Jira DVCS Connector setup
#### Troubleshooting your DVCS connection
##### Jira cannot access GitLab server
##### Scope error when connecting Jira via DVCS
##### Jira error adding account and no repositories listed
#### Fixing synchronization issues
### GitLab for Jira app **(FREE SAAS)**
#### Troubleshooting GitLab for Jira
## Usage
## Limitations

https://docs.gitlab.com/ee/user/project/integrations/jira.html contains:

# GitLab Jira integration **(FREE)**
## Configuration
### Configure Jira
#### Jira Server
#### Jira on Atlassian cloud
### Configure GitLab
#### Obtaining a transition ID
#### Disabling comments on Jira issues
## Jira issues
### Reference Jira issues
### Close Jira issues
### View Jira issues **(PREMIUM)**
#### Search and filter the issues list
## Troubleshooting
### GitLab is unable to comment on a Jira issue
### GitLab is unable to close a Jira issue
### CAPTCHA

https://docs.gitlab.com/ee/user/project/integrations/jira_cloud_configuration.html contains:

# Create an API token in Jira on Atlassian cloud **(FREE)**

https://docs.gitlab.com/ee/user/project/integrations/jira_integrations.html contains:

# Jira integrations **(FREE)**
## Integration types
## Feature comparison

https://docs.gitlab.com/ee/user/project/integrations/jira_server_configuration.html contains:

# Create Jira Server username and password **(FREE)**

Proposed

TBD.

Edited by Amy Qualls