Commit 0bf5cc6e authored by Fiona Neill's avatar Fiona Neill

Merge branch 'kpaizee-fix-integrations-steps' into 'master'

Use consistent navigation steps for integrations

See merge request gitlab-org/gitlab!85381
parents d7b875c5 18e0cf08
...@@ -22,7 +22,8 @@ Prerequisites: ...@@ -22,7 +22,8 @@ Prerequisites:
To configure your project: To configure your project:
1. Go to your project and select [**Settings > Integrations**](../../user/project/integrations/overview.md#accessing-integrations). 1. On the top bar, select **Menu > Projects** and find your project.
1. On the left sidebar, select **Settings > Integrations**.
1. Select **Jira**. 1. Select **Jira**.
1. Select **Enable integration**. 1. Select **Enable integration**.
1. Select **Trigger** actions. Your choice determines whether a mention of Jira issue 1. Select **Trigger** actions. Your choice determines whether a mention of Jira issue
......
...@@ -32,8 +32,8 @@ In Asana, create a Personal Access Token. ...@@ -32,8 +32,8 @@ In Asana, create a Personal Access Token.
Complete these steps in GitLab: Complete these steps in GitLab:
1. Go to the project you want to configure. 1. On the top bar, select **Menu > Projects** and find your project.
1. Go to the [Integrations page](overview.md#accessing-integrations). 1. On the left sidebar, select **Settings > Integrations**.
1. Select **Asana**. 1. Select **Asana**.
1. Ensure that the **Active** toggle is enabled. 1. Ensure that the **Active** toggle is enabled.
1. Paste the token you generated in Asana. 1. Paste the token you generated in Asana.
......
...@@ -14,7 +14,8 @@ You can configure Bugzilla as an ...@@ -14,7 +14,8 @@ You can configure Bugzilla as an
To enable the Bugzilla integration in a project: To enable the Bugzilla integration in a project:
1. Go to the [Integrations page](overview.md#accessing-integrations). 1. On the top bar, select **Menu > Projects** and find your project.
1. On the left sidebar, select **Settings > Integrations**.
1. Select **Bugzilla**. 1. Select **Bugzilla**.
1. Select the checkbox under **Enable integration**. 1. Select the checkbox under **Enable integration**.
1. Fill in the required fields: 1. Fill in the required fields:
......
...@@ -26,8 +26,9 @@ and configure it in GitLab. ...@@ -26,8 +26,9 @@ and configure it in GitLab.
With the webhook URL created in the Discord channel, you can set up the Discord Notifications service in GitLab. With the webhook URL created in the Discord channel, you can set up the Discord Notifications service in GitLab.
1. Navigate to the [Integrations page](overview.md#accessing-integrations) in your project's settings. That is, **Project > Settings > Integrations**. 1. On the top bar, select **Menu > Projects** and find your project.
1. Select the **Discord Notifications** integration to configure it. 1. On the left sidebar, select **Settings > Integrations**.
1. Select **Discord Notifications**.
1. Ensure that the **Active** toggle is enabled. 1. Ensure that the **Active** toggle is enabled.
1. Check the checkboxes corresponding to the GitLab events for which you want to send notifications to Discord. 1. Check the checkboxes corresponding to the GitLab events for which you want to send notifications to Discord.
1. Paste the webhook URL that you copied from the create Discord webhook step. 1. Paste the webhook URL that you copied from the create Discord webhook step.
......
...@@ -9,17 +9,18 @@ info: To determine the technical writer assigned to the Stage/Group associated w ...@@ -9,17 +9,18 @@ info: To determine the technical writer assigned to the Stage/Group associated w
By enabling this service, you receive email notifications for every change By enabling this service, you receive email notifications for every change
that is pushed to your project. that is pushed to your project.
From the [Integrations page](overview.md#accessing-integrations) To enable emails on push:
select **Emails on push** service to activate and configure it.
In the _Recipients_ area, provide a list of emails separated by spaces or newlines. 1. On the top bar, select **Menu > Projects** and find your project.
1. On the left sidebar, select **Settings > Integrations**.
1. Select **Emails on push**.
1. In the **Recipients** section, provide a list of emails separated by spaces or newlines.
1. Configure the following options:
The following options are available: - **Push events** - Email is triggered when a push event is received.
- **Tag push events** - Email is triggered when a tag is created and pushed.
- **Push events** - Email is triggered when a push event is received. - **Send from committer** - Send notifications from the committer's email address if the domain matches the domain used by your GitLab instance (such as `user@gitlab.com`).
- **Tag push events** - Email is triggered when a tag is created and pushed. - **Disable code diffs** - Don't include possibly sensitive code diffs in notification body.
- **Send from committer** - Send notifications from the committer's email address if the domain matches the domain used by your GitLab instance (such as `user@gitlab.com`).
- **Disable code diffs** - Don't include possibly sensitive code diffs in notification body.
| Settings | Notification | | Settings | Notification |
| --- | --- | | --- | --- |
......
...@@ -14,7 +14,8 @@ This IBM product was [formerly named Rational Team Concert](https://jazz.net/blo ...@@ -14,7 +14,8 @@ This IBM product was [formerly named Rational Team Concert](https://jazz.net/blo
To enable the EWM integration, in a project: To enable the EWM integration, in a project:
1. Go to the [Integrations page](overview.md#accessing-integrations). 1. On the top bar, select **Menu > Projects** and find your project.
1. On the left sidebar, select **Settings > Integrations**.
1. Select **EWM**. 1. Select **EWM**.
1. Select the checkbox under **Enable integration**. 1. Select the checkbox under **Enable integration**.
1. Fill in the required fields: 1. Fill in the required fields:
......
...@@ -39,9 +39,8 @@ network. For more details, read ...@@ -39,9 +39,8 @@ network. For more details, read
## Complete these steps in GitLab ## Complete these steps in GitLab
1. On the top bar, select **Menu > Projects** and find the project you want to 1. On the top bar, select **Menu > Projects** and find your project.
configure for notifications. 1. On the left sidebar, select **Settings > Integrations**.
1. Navigate to the [Integrations page](overview.md#accessing-integrations).
1. Select **irker (IRC gateway)**. 1. Select **irker (IRC gateway)**.
1. Ensure that the **Active** toggle is enabled. 1. Ensure that the **Active** toggle is enabled.
1. Optional. Under **Server host**, enter the server host address where `irkerd` runs. If empty, 1. Optional. Under **Server host**, enter the server host address where `irkerd` runs. If empty,
......
...@@ -37,27 +37,25 @@ Display name override is not enabled by default, you need to ask your administra ...@@ -37,27 +37,25 @@ Display name override is not enabled by default, you need to ask your administra
## Configure GitLab to send notifications to Mattermost ## Configure GitLab to send notifications to Mattermost
After the Mattermost instance has an incoming webhook set up, you can set up GitLab After the Mattermost instance has an incoming webhook set up, you can set up GitLab
to send the notifications. to send the notifications:
Navigate to the [Integrations page](overview.md#accessing-integrations) 1. On the top bar, select **Menu > Projects** and find your project.
and select the **Mattermost notifications** service. Select the GitLab events 1. On the left sidebar, select **Settings > Integrations**.
you want to generate notifications for. 1. Select **Mattermost notifications**.
1. Select the GitLab events to generate notifications for. For each event you select, input the Mattermost channel
to receive the notification. You do not need to add the hash sign (`#`).
1. Fill in the integration configuration:
For each event you select, input the Mattermost channel you want to receive the - **Webhook**: The incoming webhook URL on Mattermost, similar to
notification. You do not need to add the hash sign (`#`).
Then fill in the integration configuration:
- **Webhook**: The incoming webhook URL on Mattermost, similar to
`http://mattermost.example/hooks/5xo…`. `http://mattermost.example/hooks/5xo…`.
- **Username**: Optional. The username shown in messages sent to Mattermost. - **Username**: Optional. The username shown in messages sent to Mattermost.
To change the bot's username, provide a value. To change the bot's username, provide a value.
- **Notify only broken pipelines**: If you enable the **Pipeline** event, and you want - **Notify only broken pipelines**: If you enable the **Pipeline** event, and you want
notifications about failed pipelines only. notifications about failed pipelines only.
- **Branches for which notifications are to be sent**: The branches to send notifications for. - **Branches for which notifications are to be sent**: The branches to send notifications for.
- **Labels to be notified**: Optional. Labels required for the issue or merge request - **Labels to be notified**: Optional. Labels required for the issue or merge request
to trigger a notification. Leave blank to notify for all issues and merge requests. to trigger a notification. Leave blank to notify for all issues and merge requests.
- **Labels to be notified behavior**: When you use the **Labels to be notified** filter, - **Labels to be notified behavior**: When you use the **Labels to be notified** filter,
messages are sent when an issue or merge request contains _any_ of the labels specified messages are sent when an issue or merge request contains _any_ of the labels specified
in the filter. You can also choose to trigger messages only when the issue or merge request in the filter. You can also choose to trigger messages only when the issue or merge request
contains _all_ the labels defined in the filter. contains _all_ the labels defined in the filter.
...@@ -37,8 +37,8 @@ In Pivotal Tracker, [create an API token](https://www.pivotaltracker.com/help/ar ...@@ -37,8 +37,8 @@ In Pivotal Tracker, [create an API token](https://www.pivotaltracker.com/help/ar
Complete these steps in GitLab: Complete these steps in GitLab:
1. Go to the project you want to configure. 1. On the top bar, select **Menu > Projects** and find your project.
1. Go to the [Integrations page](overview.md#accessing-integrations). 1. On the left sidebar, select **Settings > Integrations**.
1. Select **Pivotal Tracker**. 1. Select **Pivotal Tracker**.
1. Ensure that the **Active** toggle is enabled. 1. Ensure that the **Active** toggle is enabled.
1. Paste the token you generated in Pivotal Tracker. 1. Paste the token you generated in Pivotal Tracker.
......
...@@ -62,9 +62,9 @@ GitLab can use these to access the resource. More information about authenticati ...@@ -62,9 +62,9 @@ GitLab can use these to access the resource. More information about authenticati
service account can be found at Google's documentation for service account can be found at Google's documentation for
[Authenticating from a service account](https://cloud.google.com/iap/docs/authentication-howto#authenticating_from_a_service_account). [Authenticating from a service account](https://cloud.google.com/iap/docs/authentication-howto#authenticating_from_a_service_account).
1. Navigate to the [Integrations page](overview.md#accessing-integrations) at 1. On the top bar, select **Menu > Projects** and find your project.
**Settings > Integrations**. 1. On the left sidebar, select **Settings > Integrations**.
1. Click the **Prometheus** service. 1. Select **Prometheus**.
1. For **API URL**, provide the domain name or IP address of your server, such as 1. For **API URL**, provide the domain name or IP address of your server, such as
`http://prometheus.example.com/` or `http://192.0.2.1/`. `http://prometheus.example.com/` or `http://192.0.2.1/`.
1. (Optional) In **Google IAP Audience Client ID**, provide the Client ID of the 1. (Optional) In **Google IAP Audience Client ID**, provide the Client ID of the
...@@ -73,7 +73,7 @@ service account can be found at Google's documentation for ...@@ -73,7 +73,7 @@ service account can be found at Google's documentation for
Service Account credentials file that is authorized to access the Prometheus resource. Service Account credentials file that is authorized to access the Prometheus resource.
The JSON key `token_credential_uri` is discarded to prevent The JSON key `token_credential_uri` is discarded to prevent
[Server-side Request Forgery (SSRF)](https://www.hackerone.com/application-security/how-server-side-request-forgery-ssrf). [Server-side Request Forgery (SSRF)](https://www.hackerone.com/application-security/how-server-side-request-forgery-ssrf).
1. Click **Save changes**. 1. Select **Save changes**.
![Configure Prometheus Service](img/prometheus_manual_configuration_v13_2.png) ![Configure Prometheus Service](img/prometheus_manual_configuration_v13_2.png)
...@@ -83,11 +83,12 @@ You can configure [Thanos](https://thanos.io/) as a drop-in replacement for Prom ...@@ -83,11 +83,12 @@ You can configure [Thanos](https://thanos.io/) as a drop-in replacement for Prom
with GitLab. Use the domain name or IP address of the Thanos server you'd like with GitLab. Use the domain name or IP address of the Thanos server you'd like
to integrate with. to integrate with.
1. Navigate to the [Integrations page](overview.md#accessing-integrations). 1. On the top bar, select **Menu > Projects** and find your project.
1. Click the **Prometheus** service. 1. On the left sidebar, select **Settings > Integrations**.
1. Select **Prometheus**.
1. Provide the domain name or IP address of your server, for example 1. Provide the domain name or IP address of your server, for example
`http://thanos.example.com/` or `http://192.0.2.1/`. `http://thanos.example.com/` or `http://192.0.2.1/`.
1. Click **Save changes**. 1. Select **Save changes**.
### Precedence with multiple Prometheus configurations ### Precedence with multiple Prometheus configurations
......
...@@ -10,7 +10,8 @@ Use [Redmine](https://www.redmine.org/) as the issue tracker. ...@@ -10,7 +10,8 @@ Use [Redmine](https://www.redmine.org/) as the issue tracker.
To enable the Redmine integration in a project: To enable the Redmine integration in a project:
1. Go to the [Integrations page](overview.md#accessing-integrations). 1. On the top bar, select **Menu > Projects** and find your project.
1. On the left sidebar, select **Settings > Integrations**.
1. Select **Redmine**. 1. Select **Redmine**.
1. Select the checkbox under **Enable integration**. 1. Select the checkbox under **Enable integration**.
1. Fill in the required fields: 1. Fill in the required fields:
......
...@@ -18,7 +18,7 @@ For GitLab.com, use the [GitLab Slack app](gitlab_slack_application.md) instead. ...@@ -18,7 +18,7 @@ For GitLab.com, use the [GitLab Slack app](gitlab_slack_application.md) instead.
## Configure GitLab and Slack ## Configure GitLab and Slack
Slack slash command [integrations](overview.md#accessing-integrations) Slack slash command integrations
are scoped to a project. are scoped to a project.
1. In GitLab, on the top bar, select **Menu > Projects** and find your project. 1. In GitLab, on the top bar, select **Menu > Projects** and find your project.
......
...@@ -15,7 +15,8 @@ copy its URL. ...@@ -15,7 +15,8 @@ copy its URL.
In GitLab: In GitLab:
1. Go to the [Integrations page](overview.md#accessing-integrations) in your project's settings. 1. On the top bar, select **Menu > Projects** and find your project.
1. On the left sidebar, select **Settings > Integrations**.
1. Select **Unify Circuit**. 1. Select **Unify Circuit**.
1. Turn on the **Active** toggle. 1. Turn on the **Active** toggle.
1. Select the checkboxes corresponding to the GitLab events you want to receive in Unify Circuit. 1. Select the checkboxes corresponding to the GitLab events you want to receive in Unify Circuit.
......
...@@ -14,7 +14,8 @@ You can configure YouTrack as an ...@@ -14,7 +14,8 @@ You can configure YouTrack as an
To enable the YouTrack integration in a project: To enable the YouTrack integration in a project:
1. Go to the [Integrations page](overview.md#accessing-integrations). 1. On the top bar, select **Menu > Projects** and find your project.
1. On the left sidebar, select **Settings > Integrations**.
1. Select **YouTrack**. 1. Select **YouTrack**.
1. Select the checkbox under **Enable integration**. 1. Select the checkbox under **Enable integration**.
1. Fill in the required fields: 1. Fill in the required fields:
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment