diff options
author | GitLab Bot <gitlab-bot@gitlab.com> | 2021-08-19 12:08:42 +0300 |
---|---|---|
committer | GitLab Bot <gitlab-bot@gitlab.com> | 2021-08-19 12:08:42 +0300 |
commit | b76ae638462ab0f673e5915986070518dd3f9ad3 (patch) | |
tree | bdab0533383b52873be0ec0eb4d3c66598ff8b91 /doc/integration | |
parent | 434373eabe7b4be9593d18a585fb763f1e5f1a6f (diff) |
Add latest changes from gitlab-org/gitlab@14-2-stable-eev14.2.0-rc42
Diffstat (limited to 'doc/integration')
40 files changed, 258 insertions, 232 deletions
diff --git a/doc/integration/README.md b/doc/integration/README.md deleted file mode 100644 index 7c03b957686..00000000000 --- a/doc/integration/README.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -redirect_to: 'index.md' -remove_date: '2021-07-30' ---- - -This document was moved to [another location](index.md). - -<!-- This redirect file can be deleted after <2021-07-30>. --> -<!-- Before deletion, see: https://docs.gitlab.com/ee/development/documentation/#move-or-rename-a-page --> diff --git a/doc/integration/akismet.md b/doc/integration/akismet.md index ba2b25caeff..a652025387e 100644 --- a/doc/integration/akismet.md +++ b/doc/integration/akismet.md @@ -1,14 +1,14 @@ --- -stage: Create -group: Ecosystem +stage: Ecosystem +group: Integrations info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments --- # Akismet **(FREE)** -GitLab leverages [Akismet](https://akismet.com/) to protect against spam. -GitLab uses Akismet to prevent the creation of spam issues on public projects. Issues -created through the web UI or the API can be submitted to Akismet for review. +GitLab uses [Akismet](https://akismet.com/) to prevent the creation of +spam issues on public projects. Issues created through the web UI or the API can be submitted to +Akismet for review. Detected spam is rejected, and an entry is added in the **Spam Log** section of the Admin page. @@ -19,7 +19,10 @@ NOTE: In GitLab 8.11 and later, all issues are submitted to Akismet. In earlier GitLab versions, this only applied to API and non-project members. -## Configuration +Akismet configuration is available to users on self-managed GitLab. Akismet is already enabled on +GitLab SaaS (GitLab.com), where it's configuration and management are handled by GitLab Inc. + +## Configuration **(FREE SELF)** To use Akismet: @@ -35,7 +38,7 @@ To use Akismet: ![Screenshot of Akismet settings](img/akismet_settings.png) -## Training +## Training **(FREE SELF)** To better differentiate between spam and ham, you can train the Akismet filter whenever there is a false positive or false negative. diff --git a/doc/integration/auth0.md b/doc/integration/auth0.md index 6b8b07c3707..34ee326d6d5 100644 --- a/doc/integration/auth0.md +++ b/doc/integration/auth0.md @@ -1,6 +1,6 @@ --- -stage: Create -group: Ecosystem +stage: Ecosystem +group: Integrations info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments --- diff --git a/doc/integration/azure.md b/doc/integration/azure.md index 61a8290e664..dceb135ad89 100644 --- a/doc/integration/azure.md +++ b/doc/integration/azure.md @@ -1,6 +1,6 @@ --- -stage: Create -group: Ecosystem +stage: Ecosystem +group: Integrations info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments --- diff --git a/doc/integration/bitbucket.md b/doc/integration/bitbucket.md index a492b891248..44aca1ca6b1 100644 --- a/doc/integration/bitbucket.md +++ b/doc/integration/bitbucket.md @@ -1,6 +1,6 @@ --- -stage: Create -group: Ecosystem +stage: Ecosystem +group: Integrations info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments --- diff --git a/doc/integration/cas.md b/doc/integration/cas.md index 59f41ab4368..be54c31ec01 100644 --- a/doc/integration/cas.md +++ b/doc/integration/cas.md @@ -1,6 +1,6 @@ --- -stage: Create -group: Ecosystem +stage: Ecosystem +group: Integrations info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments --- diff --git a/doc/integration/datadog.md b/doc/integration/datadog.md index 38ff004a203..e06cca19e60 100644 --- a/doc/integration/datadog.md +++ b/doc/integration/datadog.md @@ -1,6 +1,6 @@ --- -stage: Create -group: Ecosystem +stage: Ecosystem +group: Integrations info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments --- @@ -8,25 +8,44 @@ info: To determine the technical writer assigned to the Stage/Group associated w > [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/270123) in GitLab 14.1 -This integration allows sending CI/CD pipeline and job information to [Datadog](https://www.datadoghq.com/) for monitoring and troubleshooting of job failures and performance issues using the [CI Visibility](https://app.datadoghq.com/ci) product. - -You can find out more information on [Datadog's CI Visibility documentation site](https://docs.datadoghq.com/continuous_integration/). - -## How to configure it - -The integration is based on [Webhooks](../user/project/integrations/webhooks.md) and it only requires setup on GitLab. - -Configure the integration on a project or group by going to **Settings > Integrations > Datadog** for each project or group you want to instrument. You can also activate the integration for the entire GitLab instance. - -Fill in the integration configuration settings: - -- `Active` enables the integration. -- `Datadog site` specifies which [Datadog site](https://docs.datadoghq.com/getting_started/site/) to send data to. -- `API URL` (optional) allows overriding the API URL used for sending data directly, only used in advanced scenarios. -- `API key` specifies which API key to use when sending data. You can generate one in the [APIs tab](https://app.datadoghq.com/account/settings#api) of the Integrations section on Datadog. -- `Service` (optional) specifies which service name to attach to each span generated by the integration. Use this to differentiate between GitLab instances. -- `Env` (optional) specifies which environment (`env` tag) to attach to each span generated by the integration. Use this to differentiate between groups of GitLab instances (i.e. staging vs production). - -You can test the integration with the `Test settings` button. After it’s successful, click `Save changes` to finish the integration set up. - -Data sent by the integration will be available in the [CI Visibility](https://app.datadoghq.com/ci) section of your Datadog account. +This integration enables you to send CI/CD pipeline and job information to +[Datadog](https://www.datadoghq.com/). Datadog's [CI Visibility](https://app.datadoghq.com/ci) +product helps you monitor for job failures and performance issues, then troubleshoot them. +It's based on [Webhooks](../user/project/integrations/webhooks.md), +and only requires configuration on GitLab. + +## Configure the integration + +Users with the **Administrator** role can configure the integration at the +project, group, or instance level: + +1. If you do not have a Datadog API key: + 1. Sign in to Datadog. + 1. Go to the **Integrations** section. + 1. Generate an API key in the [APIs tab](https://app.datadoghq.com/account/settings#api). + Copy this value, as you need it in a later step. +1. *For project-level or group-level integrations:* In GitLab, go to your project or group. +1. *For instance-level integrations:* + 1. Sign in to GitLab as a user with the [Administrator role](../user/permissions.md). + 1. On the top bar, select **Menu >** **{admin}** **Admin**. +1. In the left sidebar, select **Settings > Integrations**. +1. Scroll to **Add an integration**, and select **Datadog**. +1. Select **Active** to enable the integration. +1. Specify the [**Datadog site**](https://docs.datadoghq.com/getting_started/site/) to send data to. +1. (Optional) To override the API URL used to send data directly, provide an **API URL**. + Used only in advanced scenarios. +1. Provide your Datadog **API key**. +1. (Optional) If you use more than one GitLab instance, provide a unique **Service** name + to differentiate between your GitLab instances. +1. (Optional) If you use groups of GitLab instances (such as staging and production + environments), provide an **Env** name. This value is attached to each span + the integration generates. +1. (Optional) Select **Test settings** to test your integration. +1. Select **Save changes**. + +When the integration sends data, you can view it in the [CI Visibility](https://app.datadoghq.com/ci) +section of your Datadog account. + +## Related links + +- [Datadog's CI Visibility](https://docs.datadoghq.com/continuous_integration/) documentation. diff --git a/doc/integration/elasticsearch.md b/doc/integration/elasticsearch.md index 23ca57cb8b8..20b66411a7e 100644 --- a/doc/integration/elasticsearch.md +++ b/doc/integration/elasticsearch.md @@ -238,7 +238,7 @@ The following Elasticsearch settings are available: | `Password` | The password of your Elasticsearch instance. | | `Number of Elasticsearch shards` | Elasticsearch indexes are split into multiple shards for performance reasons. In general, you should use at least 5 shards, and indexes with tens of millions of documents need to have more shards ([see below](#guidance-on-choosing-optimal-cluster-configuration)). Changes to this value do not take effect until the index is recreated. You can read more about tradeoffs in the [Elasticsearch documentation](https://www.elastic.co/guide/en/elasticsearch/reference/current/scalability.html). | | `Number of Elasticsearch replicas` | Each Elasticsearch shard can have a number of replicas. These are a complete copy of the shard, and can provide increased query performance or resilience against hardware failure. Increasing this value will greatly increase total disk space required by the index. | -| `Limit namespaces and projects that can be indexed` | Enabling this will allow you to select namespaces and projects to index. All other namespaces and projects will use database search instead. Please note that if you enable this option but do not select any namespaces or projects, none will be indexed. [Read more below](#limiting-namespaces-and-projects). +| `Limit namespaces and projects that can be indexed` | Enabling this will allow you to select namespaces and projects to index. All other namespaces and projects will use database search instead. If you enable this option but do not select any namespaces or projects, none will be indexed. [Read more below](#limiting-namespaces-and-projects). | `Using AWS hosted Elasticsearch with IAM credentials` | Sign your Elasticsearch requests using [AWS IAM authorization](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_access-keys.html), [AWS EC2 Instance Profile Credentials](https://docs.aws.amazon.com/codedeploy/latest/userguide/getting-started-create-iam-instance-profile.html#getting-started-create-iam-instance-profile-cli), or [AWS ECS Tasks Credentials](https://docs.aws.amazon.com/AmazonECS/latest/userguide/task-iam-roles.html). Please refer to [Identity and Access Management in Amazon Elasticsearch Service](https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-ac.html) for details of AWS hosted Elasticsearch domain access policy configuration. | | `AWS Region` | The AWS region in which your Elasticsearch service is located. | | `AWS Access Key` | The AWS access key. | @@ -567,7 +567,7 @@ For basic guidance on choosing a cluster configuration you may refer to [Elastic ### Advanced Search integration settings guidance -- The `Number of Elasticsearch shards` setting usually corresponds with the number of CPUs available in your cluster. For example, if you have a 3-node cluster with 4 cores each, this means you will benefit from having at least 3*4=12 shards in the cluster. Please note, it's only possible to change the shards number by using [Split index API](https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-split-index.html) or by reindexing to a different index with a changed number of shards. +- The `Number of Elasticsearch shards` setting usually corresponds with the number of CPUs available in your cluster. For example, if you have a 3-node cluster with 4 cores each, this means you will benefit from having at least 3*4=12 shards in the cluster. It's only possible to change the shards number by using [Split index API](https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-split-index.html) or by reindexing to a different index with a changed number of shards. - The `Number of Elasticsearch replicas` setting should most of the time be equal to `1` (each shard will have 1 replica). Using `0` is not recommended, because losing one node will corrupt the index. ### Indexing large instances diff --git a/doc/integration/external-issue-tracker.md b/doc/integration/external-issue-tracker.md index 38bcc2b9932..19f789832b9 100644 --- a/doc/integration/external-issue-tracker.md +++ b/doc/integration/external-issue-tracker.md @@ -1,6 +1,6 @@ --- -stage: Create -group: Ecosystem +stage: Ecosystem +group: Integrations info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments --- diff --git a/doc/integration/facebook.md b/doc/integration/facebook.md index c901fdfdd10..ded89dd93a4 100644 --- a/doc/integration/facebook.md +++ b/doc/integration/facebook.md @@ -1,6 +1,6 @@ --- -stage: Create -group: Ecosystem +stage: Ecosystem +group: Integrations info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments --- diff --git a/doc/integration/github.md b/doc/integration/github.md index 7459691831c..f3192e0af6c 100644 --- a/doc/integration/github.md +++ b/doc/integration/github.md @@ -1,6 +1,6 @@ --- -stage: Create -group: Ecosystem +stage: Ecosystem +group: Integrations info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments --- diff --git a/doc/integration/gitlab.md b/doc/integration/gitlab.md index 7e21685fd54..a0b438c9ffa 100644 --- a/doc/integration/gitlab.md +++ b/doc/integration/gitlab.md @@ -1,6 +1,6 @@ --- -stage: Create -group: Ecosystem +stage: Ecosystem +group: Integrations info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments --- diff --git a/doc/integration/gitpod.md b/doc/integration/gitpod.md index d8aee6e0fd2..e3cd3075bc9 100644 --- a/doc/integration/gitpod.md +++ b/doc/integration/gitpod.md @@ -17,7 +17,9 @@ your Git branches like a CI/CD server. This means you don't have to wait for dependencies to be downloaded and builds to finish, you can start coding immediately. With Gitpod you can start coding instantly on any project, branch, and merge -request from any device, at any time. +request from any device, at any time, from your browser: + +![Gitpod interface](img/gitpod_web_interface_v13_4.png) To use the GitLab Gitpod integration, it must be enabled for your GitLab instance. Users of: @@ -52,15 +54,28 @@ For GitLab self-managed instances, a GitLab administrator needs to: 1. Add your Gitpod instance URL (for example, `https://gitpod.example.com`). 1. Select the **Save changes** button. -Your users then need to [enable it for themselves](#enable-gitpod-in-your-user-settings). +Your users can then [enable it for themselves](#enable-gitpod-in-your-user-settings). ## Launch Gitpod in GitLab -You can launch Gitpod directly from GitLab by clicking the **Gitpod** button from the **Web IDE** -dropdown on the project page: +You can launch Gitpod directly from GitLab in one of these ways: -![Gitpod Button on Project Page](img/gitpod_button_project_page_v13_4.png) +- *From your project's page:* + 1. Go to your project, and navigate to the page you want to edit. + 1. Select the caret **(angle-down)** next to **Web IDE**, and select **Gitpod** + from the list: -A project launched in GitLab looks like: + ![Gitpod Button on Project Page](img/gitpod_button_project_page_v13_4.png) -![Gitpod interface](img/gitpod_web_interface_v13_4.png) + 1. Select **Open in Gitpod**. +- *From a merge request:* + 1. Go to your merge request, and select **Overview** in the tab menu. + 1. Scroll to the end of the merge request description. + 1. Select the caret **(angle-down)** next to **Web IDE**, then select **Gitpod** + from the list: + + ![Gitpod button on the merge request page](img/gitpod-button_v14_2.png) + + 1. Select **Open in Gitpod**. + +Gitpod builds your development environment for your branch. diff --git a/doc/integration/gmail_action_buttons_for_gitlab.md b/doc/integration/gmail_action_buttons_for_gitlab.md index fa0e79d4c0b..f0bcc00c0fa 100644 --- a/doc/integration/gmail_action_buttons_for_gitlab.md +++ b/doc/integration/gmail_action_buttons_for_gitlab.md @@ -1,6 +1,6 @@ --- -stage: Create -group: Ecosystem +stage: Ecosystem +group: Integrations info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments --- diff --git a/doc/integration/google.md b/doc/integration/google.md index 0e4c9b78b5f..a08944f65f1 100644 --- a/doc/integration/google.md +++ b/doc/integration/google.md @@ -1,6 +1,6 @@ --- -stage: Create -group: Ecosystem +stage: Ecosystem +group: Integrations info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments --- diff --git a/doc/integration/img/gitpod-button_v14_2.png b/doc/integration/img/gitpod-button_v14_2.png Binary files differnew file mode 100644 index 00000000000..04dd5b50a7f --- /dev/null +++ b/doc/integration/img/gitpod-button_v14_2.png diff --git a/doc/integration/index.md b/doc/integration/index.md index c725cc08556..00b65263d32 100644 --- a/doc/integration/index.md +++ b/doc/integration/index.md @@ -1,6 +1,6 @@ --- -stage: Create -group: Ecosystem +stage: Ecosystem +group: Integrations info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments comments: false --- @@ -49,6 +49,7 @@ GitLab has integrated with several security partners. For more information, see GitLab can be integrated with the following external service for continuous integration: - [Jenkins](jenkins.md) CI. +- [Datadog](datadog.md), to monitor for CI/CD job failures and performance issues. ## Feature enhancements diff --git a/doc/integration/jenkins.md b/doc/integration/jenkins.md index b6d720d2714..8910e0978b0 100644 --- a/doc/integration/jenkins.md +++ b/doc/integration/jenkins.md @@ -1,6 +1,6 @@ --- -stage: Create -group: Ecosystem +stage: Ecosystem +group: Integrations info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments --- diff --git a/doc/integration/jenkins_deprecated.md b/doc/integration/jenkins_deprecated.md index 61d1deace4f..b7e4c4f0e26 100644 --- a/doc/integration/jenkins_deprecated.md +++ b/doc/integration/jenkins_deprecated.md @@ -1,6 +1,6 @@ --- -stage: Create -group: Ecosystem +stage: Ecosystem +group: Integrations info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments --- diff --git a/doc/integration/jira/configure.md b/doc/integration/jira/configure.md new file mode 100644 index 00000000000..b11f367258d --- /dev/null +++ b/doc/integration/jira/configure.md @@ -0,0 +1,59 @@ +--- +stage: Ecosystem +group: Integrations +info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments +--- + +# Configure the Jira integration in GitLab + +You can set up the [Jira integration](index.md#jira-integration) +by configuring your project settings in GitLab. +You can also configure these settings at a [group level](../../user/admin_area/settings/project_integration_management.md#manage-group-level-default-settings-for-a-project-integration), +and for self-managed GitLab, at an [instance level](../../user/admin_area/settings/project_integration_management.md#manage-instance-level-default-settings-for-a-project-integration). + +Prerequisites: + +- Ensure your GitLab installation does not use a [relative URL](development_panel.md#limitations). +- For **Jira Server**, ensure you have a Jira username and password. + See [authentication in Jira](index.md#authentication-in-jira). +- For **Jira on Atlassian 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). + +To configure your project: + +1. Go to your project and select [**Settings > Integrations**](../../user/project/integrations/overview.md#accessing-integrations). +1. Select **Jira**. +1. Select **Enable integration**. +1. Select **Trigger** actions. Your choice determines whether a mention of Jira issue + (in a GitLab commit, merge request, or both) creates a cross-link in Jira back to GitLab. +1. To comment in the Jira issue when a **Trigger** action is made in GitLab, select + **Enable comments**. +1. To transition Jira issues when a + [closing reference](../../user/project/issues/managing_issues.md#closing-issues-automatically) + is made in GitLab, select **Enable Jira transitions**. +1. Provide Jira configuration information: + - **Web URL**: The base URL to the Jira instance web interface you're linking to + this GitLab project, such as `https://jira.example.com`. + - **Jira API URL**: The base URL to the Jira instance API, such as `https://jira-api.example.com`. + Defaults to the **Web URL** value if not set. Leave blank if using **Jira on Atlassian cloud**. + - **Username or Email**: + For **Jira Server**, use `username`. For **Jira on Atlassian cloud**, use `email`. + - **Password/API token**: + Use `password` for **Jira Server** or `API token` for **Jira on Atlassian cloud**. +1. To enable users to view Jira issues inside the GitLab project **(PREMIUM)**, select **Enable Jira issues** and + enter a Jira project key. + + You can display issues only from a single Jira project in a given GitLab project. + + WARNING: + If you enable Jira issues with this setting, all users with access to this GitLab project + can view all issues from the specified Jira project. + +1. To enable issue creation for vulnerabilities **(ULTIMATE)**, select **Enable Jira issues creation from vulnerabilities**. +1. Select the **Jira issue type**. If the dropdown is empty, select refresh (**{retry}**) and try again. +1. To verify the Jira connection is working, select **Test settings**. +1. Select **Save changes**. + +Your GitLab project can now interact with all Jira projects in your instance and the project now +displays a Jira link that opens the Jira project. diff --git a/doc/integration/jira/connect-app.md b/doc/integration/jira/connect-app.md index fcee3f7a637..d8b1e9aa867 100644 --- a/doc/integration/jira/connect-app.md +++ b/doc/integration/jira/connect-app.md @@ -1,6 +1,6 @@ --- -stage: Create -group: Ecosystem +stage: Ecosystem +group: Integrations info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments --- @@ -53,7 +53,7 @@ After a namespace is added: are synced to Jira. - From GitLab 13.8, past merge request data is synced to Jira. -Support for syncing past branch and commit data [is planned](https://gitlab.com/gitlab-org/gitlab/-/issues/263240). +Support for syncing past branch and commit data is tracked [in this issue](https://gitlab.com/gitlab-org/gitlab/-/issues/263240). ## Install the GitLab.com for Jira Cloud app for self-managed instances **(FREE SELF)** @@ -130,4 +130,4 @@ The GitLab.com for Jira Cloud app uses an iframe to add namespaces on the settin > "You need to sign in or sign up before continuing." -In this case, use [Firefox](https://www.mozilla.org/en-US/firefox/) or enable cross-site cookies in your browser. +In this case, use [Firefox](https://www.mozilla.org/en-US/firefox/), [Google Chrome](https://www.google.com/chrome/), or enable cross-site cookies in your browser. diff --git a/doc/integration/jira/development_panel.md b/doc/integration/jira/development_panel.md index 9057267d55e..c8ea224f18e 100644 --- a/doc/integration/jira/development_panel.md +++ b/doc/integration/jira/development_panel.md @@ -1,6 +1,6 @@ --- -stage: Create -group: Ecosystem +stage: Ecosystem +group: Integrations info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments --- @@ -37,7 +37,8 @@ After the integration is [set up on GitLab and Jira](#configure-the-integration) - Refer to any Jira issue by its ID (in uppercase) in GitLab branch names, commit messages, and merge request titles. -- See the linked branches, commits, and merge requests in Jira issues: +- See the linked branches, commits, and merge requests in Jira issues. +- Create GitLab branches from Jira issues ([introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/66032) in GitLab 14.2). At this time, merge requests are called "pull requests" in Jira issues. This name may change in a future Jira release. @@ -68,8 +69,8 @@ To simplify administration, we recommend that a GitLab group maintainer or group | Jira usage | GitLab.com customers need | GitLab self-managed customers need | |------------|---------------------------|------------------------------------| -| [Atlassian cloud](https://www.atlassian.com/cloud) | The [GitLab.com for Jira Cloud](https://marketplace.atlassian.com/apps/1221011/gitlab-com-for-jira-cloud?hosting=cloud&tab=overview) application installed from the [Atlassian Marketplace](https://marketplace.atlassian.com). This offers real-time sync between GitLab and Jira. | The [GitLab.com for Jira Cloud](https://marketplace.atlassian.com/apps/1221011/gitlab-com-for-jira-cloud?hosting=cloud&tab=overview), using a workaround process. See the documentation for [installing the GitLab Jira Cloud application for self-managed instances](connect-app.md#install-the-gitlabcom-for-jira-cloud-app-for-self-managed-instances) for more information. | -| Your own server | The Jira DVCS (distributed version control system) connector. This syncs data hourly. | The [Jira DVCS Connector](dvcs.md). | +| [Atlassian cloud](https://www.atlassian.com/cloud) | The [GitLab.com for Jira Cloud](https://marketplace.atlassian.com/apps/1221011/gitlab-com-for-jira-cloud?hosting=cloud&tab=overview) application installed from the [Atlassian Marketplace](https://marketplace.atlassian.com). This offers real-time sync between GitLab and Jira. For more information, see the documentation for the [GitLab.com for Jira Cloud app](connect-app.md). | The [GitLab.com for Jira Cloud](https://marketplace.atlassian.com/apps/1221011/gitlab-com-for-jira-cloud?hosting=cloud&tab=overview), using a workaround process. See the documentation for [installing the GitLab Jira Cloud application for self-managed instances](connect-app.md#install-the-gitlabcom-for-jira-cloud-app-for-self-managed-instances) for more information. | +| Your own server | The [Jira DVCS (distributed version control system) connector](dvcs.md). This syncs data hourly. | The [Jira DVCS Connector](dvcs.md). | Each GitLab project can be configured to connect to an entire Jira instance. That means after configuration, one GitLab project can interact with all Jira projects in that instance. For: @@ -82,57 +83,6 @@ configuration, one GitLab project can interact with all Jira projects in that in If you have a single Jira instance, you can pre-fill the settings. For more information, read the documentation for [central administration of project integrations](../../user/admin_area/settings/project_integration_management.md). -To enable the integration in GitLab, you must: - -1. [Configure the project in Jira](index.md#jira-integration). - The supported Jira versions are `v6.x`, `v7.x`, and `v8.x`. -1. [Enter the correct values in GitLab](#configure-gitlab). - -### Configure GitLab - -To enable the integration in your GitLab project, after you -[configure your Jira project](index.md#jira-integration): - -1. Ensure your GitLab installation does not use a relative URL, as described in - [Limitations](#limitations). -1. Go to your project and select [**Settings > Integrations**](../../user/project/integrations/overview.md#accessing-integrations). -1. Select **Jira**. -1. Select **Enable integration**. -1. Select **Trigger** actions. Your choice determines whether a mention of Jira issue - (in a GitLab commit, merge request, or both) creates a cross-link in Jira back to GitLab. -1. To comment in the Jira issue when a **Trigger** action is made in GitLab, select - **Enable comments**. -1. To transition Jira issues when a - [closing reference](../../user/project/issues/managing_issues.md#closing-issues-automatically) - is made in GitLab, select **Enable Jira transitions**. -1. Provide Jira configuration information: - - **Web URL**: The base URL to the Jira instance web interface you're linking to - this GitLab project, such as `https://jira.example.com`. - - **Jira API URL**: The base URL to the Jira instance API, such as `https://jira-api.example.com`. - Defaults to the **Web URL** value if not set. Leave blank if using **Jira on Atlassian cloud**. - - **Username or Email**: - For **Jira Server**, use `username`. For **Jira on Atlassian cloud**, use `email`. - See [authentication in Jira](index.md#authentication-in-jira). - - **Password/API token**: - Use `password` for **Jira Server** or `API token` for **Jira on Atlassian cloud**. - See [authentication in Jira](index.md#authentication-in-jira). -1. To enable users to view Jira issues inside the GitLab project **(PREMIUM)**, select **Enable Jira issues** and - enter a Jira project key. - - You can display issues only from a single Jira project in a given GitLab project. - - WARNING: - If you enable Jira issues with this setting, all users with access to this GitLab project - can view all issues from the specified Jira project. - -1. To enable issue creation for vulnerabilities **(ULTIMATE)**, select **Enable Jira issues creation from vulnerabilities**. -1. Select the **Jira issue type**. If the dropdown is empty, select refresh (**{retry}**) and try again. -1. To verify the Jira connection is working, select **Test settings**. -1. Select **Save changes**. - -Your GitLab project can now interact with all Jira projects in your instance and the project now -displays a Jira link that opens the Jira project. - ## Limitations This integration is not supported on GitLab instances under a diff --git a/doc/integration/jira/dvcs.md b/doc/integration/jira/dvcs.md index d69243e50a6..7d97312757e 100644 --- a/doc/integration/jira/dvcs.md +++ b/doc/integration/jira/dvcs.md @@ -1,6 +1,6 @@ --- -stage: Create -group: Ecosystem +stage: Ecosystem +group: Integrations info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments --- @@ -213,7 +213,7 @@ Potential resolutions: the query string. 1. If `scope=api` is missing from the URL, edit the [GitLab account configuration](#configure-a-gitlab-application-for-dvcs). Review - the **Scopes** field and ensure the `api` check box is selected. + the **Scopes** field and ensure the `api` checkbox is selected. ### Jira error adding account and no repositories listed diff --git a/doc/integration/jira/img/jira_dev_panel_jira_setup_3.png b/doc/integration/jira/img/jira_dev_panel_jira_setup_3.png Binary files differindex 4049a65f56b..c58f1d5cecc 100644 --- a/doc/integration/jira/img/jira_dev_panel_jira_setup_3.png +++ b/doc/integration/jira/img/jira_dev_panel_jira_setup_3.png diff --git a/doc/integration/jira/index.md b/doc/integration/jira/index.md index a85ffdd1feb..febd9907028 100644 --- a/doc/integration/jira/index.md +++ b/doc/integration/jira/index.md @@ -1,6 +1,6 @@ --- -stage: Create -group: Ecosystem +stage: Ecosystem +group: Integrations info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments --- @@ -19,14 +19,14 @@ in your GitLab project with any of your projects in Jira. ### Jira integration -This integration connects one or more GitLab project to a Jira instance. The Jira instance +This integration connects one or more GitLab projects to a Jira instance. The Jira instance can be hosted by you or in [Atlassian cloud](https://www.atlassian.com/cloud). The supported Jira versions are `v6.x`, `v7.x`, and `v8.x`. <i class="fa fa-youtube-play youtube" aria-hidden="true"></i> For an overview, see [Agile Management - GitLab-Jira Basic Integration](https://www.youtube.com/watch?v=fWvwkx5_00E&feature=youtu.be). -To set up the integration, [configure the project settings](development_panel.md#configure-gitlab) in GitLab. +To set up the integration, [configure the project settings](configure.md) in GitLab. You can also configure these settings at a [group level](../../user/admin_area/settings/project_integration_management.md#manage-group-level-default-settings-for-a-project-integration), and for self-managed GitLab, at an [instance level](../../user/admin_area/settings/project_integration_management.md#manage-instance-level-default-settings-for-a-project-integration). @@ -49,13 +49,14 @@ To set up the Jira development panel integration: | Capability | Jira integration | Jira Development panel integration | |-|-|-| | 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. | -| Mention a Jira issue ID in a GitLab commit message and the Jira issue shows the commit message. | Yes. The entire commit message is displayed in the Jira issue as a comment and under **Web links**. Each message links back to the commit in GitLab. | Yes, in the issue's Development panel and optionally with a custom comment on the Jira issue using Jira [Smart Commits](https://confluence.atlassian.com/fisheye/using-smart-commits-960155400.html). | +| 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/). | +| Mention a Jira issue ID in a GitLab commit message and the Jira issue shows the commit message. | Yes. The entire commit message is displayed in the Jira issue as a comment and under **Web links**. Each message links back to the commit in GitLab. | Yes, in the issue's [development panel](https://support.atlassian.com/jira-software-cloud/docs/view-development-information-for-an-issue/) and optionally with a custom comment on the Jira issue using Jira [Smart Commits](https://confluence.atlassian.com/fisheye/using-smart-commits-960155400.html). | | Mention a Jira issue ID in a GitLab branch name and the Jira issue shows the branch name. | No. | Yes, in the issue's [development panel](https://support.atlassian.com/jira-software-cloud/docs/view-development-information-for-an-issue/). | | Add Jira time tracking to an issue. | No. | Yes. Time can be specified using Jira Smart Commits. | | Use a Git commit or merge request to transition or close a Jira issue. | Yes. Only a single transition type, typically configured to close the issue by setting it to Done. | Yes. Transition to any state using Jira Smart Commits. | | Display a list of Jira issues. | Yes. **(PREMIUM)** | No. | | Create a Jira issue from a vulnerability or finding. | Yes. **(ULTIMATE)** | No. | +| 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/). | ## Authentication in Jira @@ -82,26 +83,31 @@ If these features do not work as expected, it is likely due to a problem with th ### GitLab is unable to comment on a Jira issue -Make sure that the Jira user you set up for the integration has the -correct access permission to post comments on a Jira issue and also to transition -the issue, if you'd like GitLab to also be able to do so. +If GitLab cannot comment on Jira issues, make sure the Jira user you +set up for the integration has permission to: + +- Post comments on a Jira issue. +- Transition the Jira issue. + Jira issue references and update comments do not work if the GitLab issue tracker is disabled. ### GitLab is unable to close a Jira issue -Make sure the `Transition ID` you set within the Jira settings matches the one +Make sure the `Transition ID` you set in the Jira settings matches the one your project needs to close an issue. -Make sure that the Jira issue is not already marked as resolved; that is, -the Jira issue resolution field is not set. (It should not be struck through in -Jira lists.) +Make sure that the Jira issue is not already marked as resolved. That is, +the Jira issue resolution field is not set, and the issue is not struck through in +Jira lists. ### CAPTCHA -CAPTCHA may be triggered after several consecutive failed login attempts +CAPTCHA may be triggered after several consecutive failed login attempts, which may lead to a `401 unauthorized` error when testing your Jira integration. If CAPTCHA has been triggered, you can't use Jira's REST API to -authenticate with the Jira site. You need to log in to your Jira instance +authenticate with the Jira site. + +To fix this error, sign in to your Jira instance and complete the CAPTCHA. ## Third-party Jira integrations diff --git a/doc/integration/jira/issues.md b/doc/integration/jira/issues.md index 34ca5481b85..0373506062c 100644 --- a/doc/integration/jira/issues.md +++ b/doc/integration/jira/issues.md @@ -1,13 +1,13 @@ --- -stage: Create -group: Ecosystem +stage: Ecosystem +group: Integrations info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments --- # Jira integration issue management **(FREE)** Integrating issue management with Jira requires you to [configure Jira](index.md#jira-integration) -and [enable the Jira service](development_panel.md#configure-gitlab) in GitLab. +and [enable the Jira 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. @@ -45,21 +45,18 @@ ENTITY_TITLE You can [disable comments](#disable-comments-on-jira-issues) on issues. -### Require associated Jira issue for merge requests to be merged +### Require associated Jira issue for merge requests to be merged **(ULTIMATE)** -> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/280766) in [GitLab Ultimate](https://about.gitlab.com/pricing/) 13.12 behind a feature flag, disabled by default. -> - [Deployed behind a feature flag](../../user/feature_flags.md), disabled by default. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/280766) in GitLab 13.12, disabled behind `jira_issue_association_on_merge_request` [feature flag](../../administration/feature_flags.md). > - [Enabled by default](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/61722) in GitLab 14.1. -> - Enabled on GitLab.com. -> - Recommended for production use. -> - For GitLab self-managed instances, GitLab administrators can opt to [disable it](#enable-or-disable-the-ability-to-require-an-associated-jira-issue-on-merge-requests). **(ULTIMATE SELF)** +> - [Feature flag removed](https://gitlab.com/gitlab-org/gitlab/-/issues/335280) in GitLab 14.2. You can prevent merge requests from being merged if they do not refer to a Jira issue. To enforce this: 1. Navigate to your project's **Settings > General** page. 1. Expand the **Merge requests** section. -1. Under **Merge checks**, select the **Require an associated issue from Jira** check box. +1. Under **Merge checks**, select the **Require an associated issue from Jira** checkbox. 1. Select **Save** for the changes to take effect. After you enable this feature, a merge request that doesn't reference an associated @@ -102,7 +99,7 @@ Consider this example: > [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/3622) in [GitLab Premium](https://about.gitlab.com/pricing/) 13.2. You can browse, search, and view issues from a selected Jira project directly in GitLab, -if your GitLab administrator [has configured it](development_panel.md#configure-gitlab). +if your GitLab administrator [has configured it](configure.md). To do this, in GitLab, go to your project and select **Jira > Issues list**. The issue list sorts by **Created date** by default, with the newest issues listed at the top: @@ -149,8 +146,8 @@ When you configure automatic issue transitions, you can transition a referenced Jira issue to the next available status with a category of **Done**. To configure this setting: -1. Refer to the [Configure GitLab](development_panel.md#configure-gitlab) instructions. -1. Select the **Enable Jira transitions** check box. +1. Refer to the [Configure GitLab](configure.md) instructions. +1. Select the **Enable Jira transitions** checkbox. 1. Select the **Move to Done** option. ## Custom issue transitions @@ -167,7 +164,7 @@ For advanced workflows, you can specify custom Jira transition IDs: **action** parameter in the URL. The transition ID may vary between workflows (for example, a bug instead of a story), even if the status you're changing to is the same. -1. Refer to the [Configure GitLab](development_panel.md#configure-gitlab) instructions. +1. Refer to the [Configure GitLab](configure.md) instructions. 1. Select the **Enable Jira transitions** setting. 1. Select the **Custom transitions** option. 1. Enter your transition IDs in the text field. If you insert multiple transition IDs @@ -179,24 +176,5 @@ For advanced workflows, you can specify custom Jira transition IDs: GitLab can cross-link source commits or merge requests with Jira issues without adding a comment to the Jira issue: -1. Refer to the [Configure GitLab](development_panel.md#configure-gitlab) instructions. -1. Clear the **Enable comments** check box. - -## Enable or disable the ability to require an associated Jira issue on merge requests - -The ability to require an associated Jira issue on merge requests is under development -but ready for production use. It is deployed behind a feature flag that is -**enabled by default**. -[GitLab administrators with access to the GitLab Rails console](../../administration/feature_flags.md) can opt to disable it. - -To enable it: - -```ruby -Feature.enable(:jira_issue_association_on_merge_request) -``` - -To disable it: - -```ruby -Feature.disable(:jira_issue_association_on_merge_request) -``` +1. Refer to the [Configure GitLab](configure.md) instructions. +1. Clear the **Enable comments** checkbox. diff --git a/doc/integration/jira/jira_cloud_configuration.md b/doc/integration/jira/jira_cloud_configuration.md index 7b3f2bcb249..e42a102e030 100644 --- a/doc/integration/jira/jira_cloud_configuration.md +++ b/doc/integration/jira/jira_cloud_configuration.md @@ -1,6 +1,6 @@ --- -stage: Create -group: Ecosystem +stage: Ecosystem +group: Integrations info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments --- @@ -15,8 +15,8 @@ on Atlassian cloud. To create the API token: 1. Select **Create API token** to display a modal window with an API token. 1. To copy the API token, select **Copy to clipboard**, or select **View** and write down the new API token. You need this value when you - [configure GitLab](development_panel.md#configure-gitlab). + [configure GitLab](configure.md). You need the newly created token, and the email address you used when you created it, when you -[configure GitLab](development_panel.md#configure-gitlab). +[configure GitLab](configure.md). diff --git a/doc/integration/jira/jira_server_configuration.md b/doc/integration/jira/jira_server_configuration.md index 21348416b73..52e7e5e412b 100644 --- a/doc/integration/jira/jira_server_configuration.md +++ b/doc/integration/jira/jira_server_configuration.md @@ -1,6 +1,6 @@ --- -stage: Create -group: Ecosystem +stage: Ecosystem +group: Integrations info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments --- @@ -80,4 +80,4 @@ After creating the group in Jira, grant permissions to the group by creating a p Write down the new Jira username and its password, as you need them when -[configuring GitLab](development_panel.md#configure-gitlab). +[configuring GitLab](configure.md). diff --git a/doc/integration/jira_development_panel.md b/doc/integration/jira_development_panel.md deleted file mode 100644 index 7bfebc18f47..00000000000 --- a/doc/integration/jira_development_panel.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -redirect_to: 'jira/index.md' -remove_date: '2021-06-24' ---- - -This document was moved to [another location](jira/index.md). - -<!-- This redirect file can be deleted after <2021-06-24>. --> -<!-- Before deletion, see: https://docs.gitlab.com/ee/development/documentation/#move-or-rename-a-page --> diff --git a/doc/integration/kerberos.md b/doc/integration/kerberos.md index 5b827d23772..ba3f246f5f5 100644 --- a/doc/integration/kerberos.md +++ b/doc/integration/kerberos.md @@ -261,7 +261,7 @@ offers only `basic` authentication. kerberos: # Dedicated port: Git before 2.4 does not fall back to Basic authentication if Negotiate fails. # To support both Basic and Negotiate methods with older versions of Git, configure - # nginx to proxy GitLab on an extra port (e.g. 8443) and uncomment the following lines + # nginx to proxy GitLab on an extra port (for example: 8443) and uncomment the following lines # to dedicate this port to Kerberos authentication. (default: false) use_dedicated_port: true port: 8443 diff --git a/doc/integration/oauth2_generic.md b/doc/integration/oauth2_generic.md index 84490757c16..867108d4597 100644 --- a/doc/integration/oauth2_generic.md +++ b/doc/integration/oauth2_generic.md @@ -1,6 +1,6 @@ --- -stage: Create -group: Ecosystem +stage: Ecosystem +group: Integrations info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments --- diff --git a/doc/integration/oauth_provider.md b/doc/integration/oauth_provider.md index 7540a02e520..596fff47716 100644 --- a/doc/integration/oauth_provider.md +++ b/doc/integration/oauth_provider.md @@ -51,10 +51,13 @@ To add a new application for your user: 1. In the left sidebar, select **Applications**. 1. Enter a **Name**, **Redirect URI** and OAuth 2 scopes as defined in [Authorized Applications](#authorized-applications). The **Redirect URI** is the URL where users are sent after they authorize with GitLab. -1. Select **Save application**. GitLab displays: +1. Select **Save application**. GitLab provides: - - Application ID: OAuth 2 Client ID. - - Secret: OAuth 2 Client Secret. + - The OAuth 2 Client ID in the **Application ID** field. + - The OAuth 2 Client Secret, accessible: + - In the **Secret** field in GitLab 14.1 and earlier. + - Using the **Copy** button on the **Secret** field + [in GitLab 14.2 and later](https://gitlab.com/gitlab-org/gitlab/-/issues/332844). ## Group owned applications @@ -66,10 +69,13 @@ To add a new application for a group: 1. On the left sidebar, select **Settings > Applications**. 1. Enter a **Name**, **Redirect URI** and OAuth 2 scopes as defined in [Authorized Applications](#authorized-applications). The **Redirect URI** is the URL where users are sent after they authorize with GitLab. -1. Select **Save application**. GitLab displays: +1. Select **Save application**. GitLab provides: - - Application ID: OAuth 2 Client ID. - - Secret: OAuth 2 Client Secret. + - The OAuth 2 Client ID in the **Application ID** field. + - The OAuth 2 Client Secret, accessible: + - In the **Secret** field in GitLab 14.1 and earlier. + - Using the **Copy** button on the **Secret** field + [in GitLab 14.2 and later](https://gitlab.com/gitlab-org/gitlab/-/issues/332844). ## Instance-wide applications diff --git a/doc/integration/omniauth.md b/doc/integration/omniauth.md index d5f49041f41..bba3252fe76 100644 --- a/doc/integration/omniauth.md +++ b/doc/integration/omniauth.md @@ -1,6 +1,6 @@ --- -stage: Create -group: Ecosystem +stage: Ecosystem +group: Integrations info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments --- @@ -162,19 +162,26 @@ The chosen OmniAuth provider is now active and can be used to sign in to GitLab > [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/36664) in GitLab 13.4. You can automatically link OmniAuth users with existing GitLab users if their email addresses match. -For example, the following setting is used to enable the auto link feature for both a SAML provider and the Twitter OAuth provider: +Automatic linking using this method works for all providers +[except the SAML provider](https://gitlab.com/gitlab-org/gitlab/-/issues/338293). For automatic +linking using the SAML provider, see [SAML-specific](saml.md#general-setup) instructions. + +As an example, the following configuration is used to enable the auto link feature for both: + +- OpenID Connect provider. +- Twitter OAuth provider. **For Omnibus installations** ```ruby -gitlab_rails['omniauth_auto_link_user'] = ["saml", "twitter"] +gitlab_rails['omniauth_auto_link_user'] = ["openid_connect", "twitter"] ``` **For installations from source** ```yaml omniauth: - auto_link_user: ["saml", "twitter"] + auto_link_user: ["openid_connect", "twitter"] ``` ## Configure OmniAuth Providers as External @@ -264,7 +271,7 @@ To enable/disable an OmniAuth provider: 1. On the top bar, select **Menu >** **{admin}** **Admin**. 1. In the left sidebar, go to **Settings**. 1. Scroll to the **Sign-in Restrictions** section, and click **Expand**. -1. Below **Enabled OAuth Sign-In sources**, select the check box for each provider you want to enable or disable. +1. Below **Enabled OAuth Sign-In sources**, select the checkbox for each provider you want to enable or disable. ![Enabled OAuth Sign-In sources](img/enabled-oauth-sign-in-sources_v13_10.png) diff --git a/doc/integration/openid_connect_provider.md b/doc/integration/openid_connect_provider.md index b37c5064063..84457485382 100644 --- a/doc/integration/openid_connect_provider.md +++ b/doc/integration/openid_connect_provider.md @@ -1,6 +1,6 @@ --- -stage: Create -group: Ecosystem +stage: Ecosystem +group: Integrations info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments --- diff --git a/doc/integration/recaptcha.md b/doc/integration/recaptcha.md index 9ffc89e2c13..656ed8b8647 100644 --- a/doc/integration/recaptcha.md +++ b/doc/integration/recaptcha.md @@ -1,6 +1,6 @@ --- -stage: Create -group: Ecosystem +stage: Ecosystem +group: Integrations info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments --- diff --git a/doc/integration/salesforce.md b/doc/integration/salesforce.md index 102b89298a1..56d9feb14e0 100644 --- a/doc/integration/salesforce.md +++ b/doc/integration/salesforce.md @@ -1,6 +1,6 @@ --- -stage: Create -group: Ecosystem +stage: Ecosystem +group: Integrations info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments --- diff --git a/doc/integration/saml.md b/doc/integration/saml.md index 8e34f115072..ee3e2f574c7 100644 --- a/doc/integration/saml.md +++ b/doc/integration/saml.md @@ -707,7 +707,7 @@ Examples: - [Auth0](https://auth0.com/docs/protocols/saml-protocol/configure-auth0-as-saml-identity-provider) - [PingOne by Ping Identity](https://docs.pingidentity.com/bundle/pingone/page/xsh1564020480660-1.html) -Please note that GitLab provides the following setup notes for guidance only. +GitLab provides the following setup notes for guidance only. If you have any questions on configuring the SAML app, please contact your provider's support. ### Okta setup notes diff --git a/doc/integration/slash_commands.md b/doc/integration/slash_commands.md index 1f2259a2d57..b9b5f394e3c 100644 --- a/doc/integration/slash_commands.md +++ b/doc/integration/slash_commands.md @@ -1,6 +1,6 @@ --- -stage: Create -group: Ecosystem +stage: Ecosystem +group: Integrations info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments --- diff --git a/doc/integration/trello_power_up.md b/doc/integration/trello_power_up.md index e8956271508..df1d9270bd5 100644 --- a/doc/integration/trello_power_up.md +++ b/doc/integration/trello_power_up.md @@ -1,6 +1,6 @@ --- -stage: Create -group: Ecosystem +stage: Ecosystem +group: Integrations info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments --- diff --git a/doc/integration/twitter.md b/doc/integration/twitter.md index 58e111be73c..1d711ea271e 100644 --- a/doc/integration/twitter.md +++ b/doc/integration/twitter.md @@ -1,6 +1,6 @@ --- -stage: Create -group: Ecosystem +stage: Ecosystem +group: Integrations info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments --- |