summaryrefslogtreecommitdiff
path: root/doc/integration
diff options
context:
space:
mode:
authorGitLab Bot <gitlab-bot@gitlab.com>2023-04-26 15:17:18 +0000
committerGitLab Bot <gitlab-bot@gitlab.com>2023-04-26 15:17:18 +0000
commit34283a71d9ac31eb4da0b59d0b25fc2be014bc9c (patch)
tree4a780bf8d9c57c3b8ce34fc81152d8a87f71d594 /doc/integration
parent9edf852c3a851d84b85bc94f7a3b41d5ef04dd32 (diff)
downloadgitlab-ce-34283a71d9ac31eb4da0b59d0b25fc2be014bc9c.tar.gz
Add latest changes from gitlab-org/gitlab@master
Diffstat (limited to 'doc/integration')
-rw-r--r--doc/integration/jira/configure.md25
-rw-r--r--doc/integration/jira/connect-app.md3
-rw-r--r--doc/integration/jira/index.md52
-rw-r--r--doc/integration/jira/issues.md9
4 files changed, 31 insertions, 58 deletions
diff --git a/doc/integration/jira/configure.md b/doc/integration/jira/configure.md
index f1f7a34ac94..7503ae993dc 100644
--- a/doc/integration/jira/configure.md
+++ b/doc/integration/jira/configure.md
@@ -4,22 +4,20 @@ group: Integrations
info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/product/ux/technical-writing/#assignments
---
-# Jira integration **(FREE)**
+# Jira issue integration **(FREE)**
-The Jira integration connects one or more GitLab projects to a Jira instance. You can host the Jira instance yourself or in [Atlassian Cloud](https://www.atlassian.com/migration/assess/why-cloud). The supported Jira versions are `6.x`, `7.x`, `8.x`, and `9.x`.
+The Jira issue integration connects one or more GitLab projects to a Jira instance. You can host the Jira instance yourself or in [Jira Cloud](https://www.atlassian.com/migration/assess/why-cloud). The supported Jira versions are `6.x`, `7.x`, `8.x`, and `9.x`.
## Configure the integration
Prerequisites:
-- Ensure your GitLab installation does not use a [relative URL](https://docs.gitlab.com/omnibus/settings/configuration.html#configure-a-relative-url-for-gitlab).
-- For **Jira Server**, ensure you have a Jira username and password.
- See [authentication in Jira](index.md#authentication-in-jira).
-- For **Jira Cloud**, ensure you have an API token
- and the email address you used to create the token.
- See [authentication in Jira](index.md#authentication-in-jira).
+- Your GitLab installation must not use a [relative URL](https://docs.gitlab.com/omnibus/settings/configuration.html#configure-a-relative-url-for-gitlab).
+- **For Jira Server**, you must have a Jira username and password.
+- **For Jira Cloud**, you must have a [Jira Cloud API token](#create-a-jira-cloud-api-token) and
+ the email address you used to create the token.
-You can enable the Jira integration by configuring your project settings in GitLab.
+You can enable the Jira issue integration by configuring your project settings in GitLab.
You can also configure these settings at the:
- [Group level](../../user/admin_area/settings/project_integration_management.md#manage-group-level-default-settings-for-a-project-integration)
@@ -66,7 +64,7 @@ displays a Jira link that opens the Jira project.
## Create a Jira Cloud API token
-To [integrate with Jira](index.md) in Atlassian Cloud, you must create an API token.
+To configure the integration with Jira Cloud, you must create a Jira Cloud API token.
To create a Jira Cloud API token:
@@ -81,11 +79,6 @@ To create a Jira Cloud API token:
To copy the API token, select **Copy** and paste the token somewhere safe.
-To configure GitLab, you need:
-
-- The newly created token
-- The email address you used when you created the token
-
## Migrate from Jira Server to Jira Cloud in GitLab
To migrate from Jira Server to Jira Cloud in GitLab and maintain your Jira integration:
@@ -95,7 +88,7 @@ To migrate from Jira Server to Jira Cloud in GitLab and maintain your Jira integ
1. Select **Jira**.
1. In **Web URL**, enter the new Jira site URL (for example, `https://myjirasite.atlassian.net`).
1. In **Username or Email**, enter the username or email registered on your Jira profile.
-1. [Create an API token](#create-a-jira-cloud-api-token), and copy that value.
+1. [Create a Jira Cloud API token](#create-a-jira-cloud-api-token), and copy the token value.
1. In **Password or API token**, paste the API token value.
1. Optional. Select **Test settings** to check if the connection is working.
1. Select **Save changes**.
diff --git a/doc/integration/jira/connect-app.md b/doc/integration/jira/connect-app.md
index 7ef6a542993..617de05d480 100644
--- a/doc/integration/jira/connect-app.md
+++ b/doc/integration/jira/connect-app.md
@@ -79,7 +79,6 @@ To create an OAuth application:
1. Expand **GitLab for Jira App**.
1. Paste the **Application ID** value into **Jira Connect Application ID**.
1. Select **Save changes**.
-1. Optional. Enable the `jira_connect_oauth` [feature flag](../../administration/feature_flags.md) to avoid [authentication problems in some browsers](#browser-displays-a-sign-in-message-when-already-signed-in).
## Connect the GitLab for Jira Cloud app for self-managed instances **(FREE SELF)**
@@ -252,7 +251,7 @@ You need to sign in or sign up before continuing.
The GitLab for Jira Cloud app uses an iframe to add namespaces on the
settings page. Some browsers block cross-site cookies, which can lead to this issue.
-To resolve this issue, set up [OAuth authentication](#set-up-oauth-authentication-for-self-managed-instances) and enable the `jira_connect_oauth` [feature flag](../../administration/feature_flags.md).
+To resolve this issue, set up [OAuth authentication](#set-up-oauth-authentication-for-self-managed-instances).
### Manual installation fails
diff --git a/doc/integration/jira/index.md b/doc/integration/jira/index.md
index 5b60994e94c..44ac4ef2d07 100644
--- a/doc/integration/jira/index.md
+++ b/doc/integration/jira/index.md
@@ -6,38 +6,34 @@ info: To determine the technical writer assigned to the Stage/Group associated w
# Jira **(FREE)**
-If your organization uses [Jira](https://www.atlassian.com/software/jira) issues,
-you can [migrate your issues from Jira](../../user/project/import/jira.md) and work
-exclusively in GitLab. However, if you'd like to continue to use Jira, you can
-integrate it with GitLab. GitLab offers two types of Jira integrations, and you
-can use one or both depending on the capabilities you need.
+If your organization uses [Jira](https://www.atlassian.com/software/jira),
+you can [migrate your issues from Jira to GitLab](../../user/project/import/jira.md).
+If you want to continue to use Jira, you can integrate Jira with GitLab instead.
-## Compare integrations
+## Jira integrations
-After you set up one or both of these integrations, you can cross-reference activity
-in your GitLab project with any of your projects in Jira.
+GitLab offers two types of Jira integrations. You can
+use one or both depending on the capabilities you need.
-### Jira integration
+### Jira issue integration
-The Jira integration connects one or more GitLab projects to a Jira instance. You can host
-the Jira instance yourself or in [Atlassian Cloud](https://www.atlassian.com/migration/assess/why-cloud).
-The supported Jira versions are `6.x`, `7.x`, `8.x`, and `9.x`.
+You can use the [Jira issue integration](configure.md) developed by GitLab with Jira Cloud, Jira Data Center, or Jira Server. With this integration, you can:
-For more information, see [Jira integration](configure.md).
+- View and search Jira issues directly in GitLab.
+- Refer to Jira issues by ID in GitLab commits and merge requests.
+- Create Jira issues for vulnerabilities.
### Jira development panel
-The [Jira development panel](development_panel.md) connects all GitLab projects in a group or personal namespace.
-When you configure the Jira development panel, you can
-[view GitLab activity for an issue](https://support.atlassian.com/jira-software-cloud/docs/view-development-information-for-an-issue/)
-including related branches, commits, and merge requests.
+You can use the [Jira development panel](development_panel.md) to [view GitLab activity for an issue](https://support.atlassian.com/jira-software-cloud/docs/view-development-information-for-an-issue/)
+including related branches, commits, and merge requests. To configure the Jira development panel:
-To set up the Jira development panel, use the GitLab for Jira Cloud app
-or the Jira DVCS connector. For more information, see [Configure the panel](development_panel.md#configure-the-panel).
+- **For Jira Cloud**, use the [GitLab for Jira Cloud app](connect-app.md) developed by GitLab.
+- **For Jira Data Center or Jira Server**, use the [Jira DVCS connector](dvcs/index.md) developed by Atlassian.
-### Direct feature comparison
+## Jira integration capabilities
-| Capability | Jira integration | Jira development panel |
+| Capability | Jira issue integration | Jira development panel |
|-|-|-|
| Mention a Jira issue ID in a GitLab commit or merge request, and a link to the Jira issue is created. | Yes. | No. |
| Mention a Jira issue ID in GitLab and the Jira issue shows the GitLab issue or merge request. | Yes. A Jira comment with the GitLab issue or MR title links to GitLab. The first mention is also added to the Jira issue under **Web links**. | Yes, in the issue's [development panel](https://support.atlassian.com/jira-software-cloud/docs/view-development-information-for-an-issue/). |
@@ -50,25 +46,13 @@ or the Jira DVCS connector. For more information, see [Configure the panel](deve
| Create a GitLab branch from a Jira issue. | No. | Yes, in the issue's [development panel](https://support.atlassian.com/jira-software-cloud/docs/view-development-information-for-an-issue/). |
| Mention a Jira issue ID in a GitLab merge request, and deployments are synced. | No. | Yes, in the issue's [development panel](https://support.atlassian.com/jira-software-cloud/docs/view-development-information-for-an-issue/). |
-## Authentication in Jira
-
-The authentication method in Jira depends on whether you host Jira on your own server or on
-[Atlassian cloud](https://www.atlassian.com/migration/assess/why-cloud):
-
-- **Jira Server** supports basic authentication. When connecting, a **username and password** are
- required. Connecting to Jira Server using the Central Authentication Service (CAS) is not possible. For more information, read
- how to [set up a user in Jira Server](jira_server_configuration.md).
-- **Jira on Atlassian cloud** supports authentication through an API token. When connecting to Jira on
- Atlassian cloud, an email and API token are required. For more information, see
- [Create a Jira Cloud API token](configure.md#create-a-jira-cloud-api-token).
-
## Privacy considerations
All Jira integrations share data with Jira to make it visible outside of GitLab.
If you integrate a private GitLab project with Jira, the private data is
shared with users who have access to your Jira project.
-The [Jira integration](#jira-integration) posts GitLab data in the form of comments in Jira issues.
+The [Jira issue integration](configure.md) posts GitLab data in the form of comments in Jira issues.
The GitLab for Jira Cloud app and Jira DVCS connector share this data through the [Jira development panel](development_panel.md).
This method provides more fine-grained access control because access can be restricted to certain user groups or roles.
diff --git a/doc/integration/jira/issues.md b/doc/integration/jira/issues.md
index e7802a5fde2..fcf0bf791d4 100644
--- a/doc/integration/jira/issues.md
+++ b/doc/integration/jira/issues.md
@@ -6,12 +6,9 @@ info: To determine the technical writer assigned to the Stage/Group associated w
# Jira issue management **(FREE)**
-To integrate issue management with Jira, [configure Jira](index.md#jira-integration)
-and [enable the integration](configure.md) in GitLab.
-After you configure and enable the integration, you can reference and close Jira
-issues by mentioning the Jira ID in GitLab commits and merge requests.
-
-The Jira integration requires to you format any Jira issue IDs in uppercase.
+You can [manage Jira issues directly in GitLab](configure.md).
+You can then refer to Jira issues by ID in GitLab commits and merge requests.
+The Jira issue IDs must be in uppercase.
## Reference Jira issues