From 6e4e1050d9dba2b7b2523fdd1768823ab85feef4 Mon Sep 17 00:00:00 2001 From: GitLab Bot Date: Thu, 20 Aug 2020 18:42:06 +0000 Subject: Add latest changes from gitlab-org/gitlab@13-3-stable-ee --- doc/user/project/integrations/bamboo.md | 6 ++ doc/user/project/integrations/bugzilla.md | 6 ++ .../project/integrations/custom_issue_tracker.md | 8 +- .../project/integrations/discord_notifications.md | 6 ++ doc/user/project/integrations/emails_on_push.md | 6 ++ doc/user/project/integrations/generic_alerts.md | 8 +- doc/user/project/integrations/github.md | 8 +- .../integrations/gitlab_slack_application.md | 10 +- doc/user/project/integrations/hangouts_chat.md | 6 ++ doc/user/project/integrations/hipchat.md | 6 ++ .../actions_menu_create_new_dashboard_v13_2.png | Bin 11479 -> 0 bytes .../integrations/img/copy_link_to_chart_v12_10.png | Bin 21559 -> 0 bytes .../img/embed_metrics_issue_template.png | Bin 43908 -> 0 bytes .../img/embedded_metrics_markdown_v12_8.png | Bin 13818 -> 0 bytes .../img/embedded_metrics_rendered_v12_8.png | Bin 66002 -> 0 bytes .../project/integrations/img/grafana_embedded.png | Bin 28071 -> 0 bytes .../integrations/img/grafana_live_embed.png | Bin 44603 -> 0 bytes .../integrations/img/grafana_panel_v12_5.png | Bin 44193 -> 0 bytes .../img/grafana_sharing_dialog_v12_5.png | Bin 41203 -> 0 bytes .../img/heatmap_chart_too_much_data_v_13_2.png | Bin 7310 -> 0 bytes .../integrations/img/heatmap_panel_type.png | Bin 8272 -> 0 bytes .../img/hide_embedded_metrics_v12_10.png | Bin 21312 -> 0 bytes .../integrations/img/http_proxy_access_v12_5.png | Bin 47813 -> 0 bytes .../img/metrics_dashboard_annotations_ui_v13.0.png | Bin 31654 -> 0 bytes .../img/metrics_settings_button_v13_2.png | Bin 1901 -> 0 bytes .../integrations/img/panel_context_menu_v13_0.png | Bin 34737 -> 0 bytes .../img/project_integrations_v13_3.png | Bin 0 -> 38249 bytes .../project/integrations/img/project_services.png | Bin 11109 -> 0 bytes .../integrations/img/prometheus_add_metric.png | Bin 47690 -> 0 bytes .../project/integrations/img/prometheus_alert.png | Bin 8192 -> 0 bytes .../img/prometheus_cluster_health_embed_v12_9.png | Bin 50178 -> 0 bytes .../prometheus_dashboard_anomaly_panel_type.png | Bin 41015 -> 0 bytes .../prometheus_dashboard_area_panel_type_v12_8.png | Bin 53370 -> 0 bytes ...theus_dashboard_bar_chart_panel_type_v12.10.png | Bin 4761 -> 0 bytes .../img/prometheus_dashboard_column_panel_type.png | Bin 13219 -> 0 bytes ...rometheus_dashboard_edit_metric_link_v_12_9.png | Bin 29178 -> 0 bytes .../prometheus_dashboard_environments_v12_8.png | Bin 7422 -> 0 bytes ...ometheus_dashboard_label_variable_shorthand.png | Bin 3897 -> 0 bytes .../img/prometheus_dashboard_label_variables.png | Bin 8076 -> 0 bytes .../img/prometheus_dashboard_repeated_label.png | Bin 3116 -> 0 bytes .../img/prometheus_dashboard_select_v_13_0.png | Bin 14284 -> 0 bytes ...prometheus_dashboard_single_stat_panel_type.png | Bin 6871 -> 0 bytes ...s_dashboard_stacked_column_panel_type_v12_8.png | Bin 13898 -> 0 bytes .../prometheus_dashboard_yaml_validation_v13_1.png | Bin 27694 -> 0 bytes .../img/prometheus_monitoring_dashboard_v13_1.png | Bin 40765 -> 0 bytes .../integrations/img/prometheus_service_alerts.png | Bin 16084 -> 0 bytes .../integrations/img/related_links_v13_1.png | Bin 4086 -> 0 bytes .../img/rendered_grafana_embed_v12_5.png | Bin 61194 -> 0 bytes .../img/select_query_variables_v12_5.png | Bin 7368 -> 0 bytes .../img/view_embedded_metrics_v12_10.png | Bin 36717 -> 0 bytes .../integrations/img/webex_teams_configuration.png | Bin 250628 -> 75327 bytes doc/user/project/integrations/index.md | 6 ++ doc/user/project/integrations/irker.md | 6 ++ doc/user/project/integrations/jira.md | 53 ++++++----- .../integrations/jira_cloud_configuration.md | 6 ++ doc/user/project/integrations/jira_integrations.md | 35 +++++++ .../integrations/jira_server_configuration.md | 6 ++ doc/user/project/integrations/mattermost.md | 6 ++ .../integrations/mattermost_slash_commands.md | 12 ++- doc/user/project/integrations/microsoft_teams.md | 6 ++ doc/user/project/integrations/mock_ci.md | 6 ++ doc/user/project/integrations/overview.md | 20 +++- doc/user/project/integrations/prometheus.md | 5 +- .../integrations/prometheus_library/cloudwatch.md | 2 +- doc/user/project/integrations/redmine.md | 6 ++ .../project/integrations/services_templates.md | 6 ++ doc/user/project/integrations/slack.md | 8 +- .../project/integrations/slack_slash_commands.md | 6 ++ doc/user/project/integrations/unify_circuit.md | 6 ++ doc/user/project/integrations/webex_teams.md | 6 ++ doc/user/project/integrations/webhooks.md | 102 ++++++++++++++++----- doc/user/project/integrations/youtrack.md | 6 ++ 72 files changed, 321 insertions(+), 64 deletions(-) delete mode 100644 doc/user/project/integrations/img/actions_menu_create_new_dashboard_v13_2.png delete mode 100644 doc/user/project/integrations/img/copy_link_to_chart_v12_10.png delete mode 100644 doc/user/project/integrations/img/embed_metrics_issue_template.png delete mode 100644 doc/user/project/integrations/img/embedded_metrics_markdown_v12_8.png delete mode 100644 doc/user/project/integrations/img/embedded_metrics_rendered_v12_8.png delete mode 100644 doc/user/project/integrations/img/grafana_embedded.png delete mode 100644 doc/user/project/integrations/img/grafana_live_embed.png delete mode 100644 doc/user/project/integrations/img/grafana_panel_v12_5.png delete mode 100644 doc/user/project/integrations/img/grafana_sharing_dialog_v12_5.png delete mode 100644 doc/user/project/integrations/img/heatmap_chart_too_much_data_v_13_2.png delete mode 100644 doc/user/project/integrations/img/heatmap_panel_type.png delete mode 100644 doc/user/project/integrations/img/hide_embedded_metrics_v12_10.png delete mode 100644 doc/user/project/integrations/img/http_proxy_access_v12_5.png delete mode 100644 doc/user/project/integrations/img/metrics_dashboard_annotations_ui_v13.0.png delete mode 100644 doc/user/project/integrations/img/metrics_settings_button_v13_2.png delete mode 100644 doc/user/project/integrations/img/panel_context_menu_v13_0.png create mode 100644 doc/user/project/integrations/img/project_integrations_v13_3.png delete mode 100644 doc/user/project/integrations/img/project_services.png delete mode 100644 doc/user/project/integrations/img/prometheus_add_metric.png delete mode 100644 doc/user/project/integrations/img/prometheus_alert.png delete mode 100644 doc/user/project/integrations/img/prometheus_cluster_health_embed_v12_9.png delete mode 100644 doc/user/project/integrations/img/prometheus_dashboard_anomaly_panel_type.png delete mode 100644 doc/user/project/integrations/img/prometheus_dashboard_area_panel_type_v12_8.png delete mode 100644 doc/user/project/integrations/img/prometheus_dashboard_bar_chart_panel_type_v12.10.png delete mode 100644 doc/user/project/integrations/img/prometheus_dashboard_column_panel_type.png delete mode 100644 doc/user/project/integrations/img/prometheus_dashboard_edit_metric_link_v_12_9.png delete mode 100644 doc/user/project/integrations/img/prometheus_dashboard_environments_v12_8.png delete mode 100644 doc/user/project/integrations/img/prometheus_dashboard_label_variable_shorthand.png delete mode 100644 doc/user/project/integrations/img/prometheus_dashboard_label_variables.png delete mode 100644 doc/user/project/integrations/img/prometheus_dashboard_repeated_label.png delete mode 100644 doc/user/project/integrations/img/prometheus_dashboard_select_v_13_0.png delete mode 100644 doc/user/project/integrations/img/prometheus_dashboard_single_stat_panel_type.png delete mode 100644 doc/user/project/integrations/img/prometheus_dashboard_stacked_column_panel_type_v12_8.png delete mode 100644 doc/user/project/integrations/img/prometheus_dashboard_yaml_validation_v13_1.png delete mode 100644 doc/user/project/integrations/img/prometheus_monitoring_dashboard_v13_1.png delete mode 100644 doc/user/project/integrations/img/prometheus_service_alerts.png delete mode 100644 doc/user/project/integrations/img/related_links_v13_1.png delete mode 100644 doc/user/project/integrations/img/rendered_grafana_embed_v12_5.png delete mode 100644 doc/user/project/integrations/img/select_query_variables_v12_5.png delete mode 100644 doc/user/project/integrations/img/view_embedded_metrics_v12_10.png create mode 100644 doc/user/project/integrations/jira_integrations.md (limited to 'doc/user/project/integrations') diff --git a/doc/user/project/integrations/bamboo.md b/doc/user/project/integrations/bamboo.md index 7b21c590c8a..9cade323ed2 100644 --- a/doc/user/project/integrations/bamboo.md +++ b/doc/user/project/integrations/bamboo.md @@ -1,3 +1,9 @@ +--- +stage: Create +group: Ecosystem +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/#designated-technical-writers +--- + # Atlassian Bamboo CI Service GitLab provides integration with Atlassian Bamboo for continuous integration. diff --git a/doc/user/project/integrations/bugzilla.md b/doc/user/project/integrations/bugzilla.md index 6d44c56743e..2ed14a4c69c 100644 --- a/doc/user/project/integrations/bugzilla.md +++ b/doc/user/project/integrations/bugzilla.md @@ -1,3 +1,9 @@ +--- +stage: Create +group: Ecosystem +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/#designated-technical-writers +--- + # Bugzilla Service Navigate to the [Integrations page](overview.md#accessing-integrations), diff --git a/doc/user/project/integrations/custom_issue_tracker.md b/doc/user/project/integrations/custom_issue_tracker.md index 7d15ae82b6f..1329f584fdc 100644 --- a/doc/user/project/integrations/custom_issue_tracker.md +++ b/doc/user/project/integrations/custom_issue_tracker.md @@ -1,8 +1,14 @@ +--- +stage: Create +group: Ecosystem +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/#designated-technical-writers +--- + # Custom Issue Tracker service To enable the Custom Issue Tracker integration in a project: -1. Go to **{settings}** **Settings > Integrations**. +1. Go to **Settings > Integrations**. 1. Click **Custom Issue Tracker** 1. Fill in the tracker's details, such as title, description, and URLs. You will be able to edit these fields later as well. diff --git a/doc/user/project/integrations/discord_notifications.md b/doc/user/project/integrations/discord_notifications.md index aa45cc38cb5..f261362eeae 100644 --- a/doc/user/project/integrations/discord_notifications.md +++ b/doc/user/project/integrations/discord_notifications.md @@ -1,3 +1,9 @@ +--- +stage: Create +group: Ecosystem +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/#designated-technical-writers +--- + # Discord Notifications service > [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/22684) in GitLab 11.6. diff --git a/doc/user/project/integrations/emails_on_push.md b/doc/user/project/integrations/emails_on_push.md index b0838690d3b..d8b864e0396 100644 --- a/doc/user/project/integrations/emails_on_push.md +++ b/doc/user/project/integrations/emails_on_push.md @@ -1,3 +1,9 @@ +--- +stage: Create +group: Ecosystem +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/#designated-technical-writers +--- + # Enabling emails on push By enabling this service, you will receive email notifications for every change diff --git a/doc/user/project/integrations/generic_alerts.md b/doc/user/project/integrations/generic_alerts.md index 3490a3f2b9e..dc6aa40ea82 100644 --- a/doc/user/project/integrations/generic_alerts.md +++ b/doc/user/project/integrations/generic_alerts.md @@ -29,8 +29,8 @@ To obtain credentials for setting up a generic alerts integration: - Sign in to GitLab as a user with maintainer [permissions](../../permissions.md) for a project. - Navigate to the **Operations** page for your project, depending on your installed version of GitLab: - - *In GitLab versions 13.1 and greater,* navigate to **{settings}** **Settings > Operations** in your project. - - *In GitLab versions prior to 13.1,* navigate to **{settings}** **Settings > Integrations** in your project. GitLab will display a banner encouraging you to enable the Alerts endpoint in **{settings}** **Settings > Operations** instead. + - *In GitLab versions 13.1 and greater,* navigate to **Settings > Operations** in your project. + - *In GitLab versions prior to 13.1,* navigate to **Settings > Integrations** in your project. GitLab will display a banner encouraging you to enable the Alerts endpoint in **Settings > Operations** instead. - Click **Alerts endpoint**. - Toggle the **Active** alert setting to display the **URL** and **Authorization Key** for the webhook configuration. @@ -101,7 +101,7 @@ After a [project maintainer or owner](#setting-up-generic-alerts) test alert to confirm your integration works properly. 1. Sign in as a user with Developer or greater [permissions](../../../user/permissions.md). -1. Navigate to **{settings}** **Settings > Operations** in your project. +1. Navigate to **Settings > Operations** in your project. 1. Click **Alerts endpoint** to expand the section. 1. Enter a sample payload in **Alert test payload** (valid JSON is required). 1. Click **Test alert payload**. @@ -116,7 +116,7 @@ In GitLab versions 13.2 and greater, GitLab groups alerts based on their payload When an incoming alert contains the same payload as another alert (excluding the `start_time` and `hosts` attributes), GitLab groups these alerts together and displays a counter on the -[Alert Management List](../operations/alert_management.md#alert-management-list) +[Alert Management List](../../../operations/incident_management/incidents.md) and details pages. If the existing alert is already `resolved`, then a new alert will be created instead. diff --git a/doc/user/project/integrations/github.md b/doc/user/project/integrations/github.md index 416996fb629..29818e862e0 100644 --- a/doc/user/project/integrations/github.md +++ b/doc/user/project/integrations/github.md @@ -1,3 +1,9 @@ +--- +stage: Create +group: Ecosystem +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/#designated-technical-writers +--- + # GitHub project integration **(PREMIUM)** > [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/3836) in GitLab Premium 10.6. @@ -14,7 +20,7 @@ and is automatically configured on [GitHub import](../../../integration/github.m ### Complete these steps on GitHub -This integration requires a [GitHub API token](https://help.github.com/en/github/authenticating-to-github/creating-a-personal-access-token) +This integration requires a [GitHub API token](https://docs.github.com/en/github/authenticating-to-github/creating-a-personal-access-token) with `repo:status` access granted: 1. Go to your "Personal access tokens" page at diff --git a/doc/user/project/integrations/gitlab_slack_application.md b/doc/user/project/integrations/gitlab_slack_application.md index 7a827364d41..62fccb22d36 100644 --- a/doc/user/project/integrations/gitlab_slack_application.md +++ b/doc/user/project/integrations/gitlab_slack_application.md @@ -1,3 +1,9 @@ +--- +stage: Create +group: Ecosystem +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/#designated-technical-writers +--- + # GitLab Slack application **(FREE ONLY)** > - Introduced in GitLab 9.4. @@ -36,7 +42,7 @@ docs on [Adding an app to your workspace](https://slack.com/help/articles/202035 To enable GitLab's service for your Slack team: -1. Go to your project's **{settings}** **Settings > Integration > Slack application** (only +1. Go to your project's **Settings > Integration > Slack application** (only visible on GitLab.com). 1. Click **Add to Slack**. @@ -47,7 +53,7 @@ That's all! You can now start using the Slack slash commands. To create a project alias on GitLab.com for Slack integration: 1. Go to your project's home page. -1. Navigate to **{settings}** **Settings > Integrations** (only visible on GitLab.com) +1. Navigate to **Settings > Integrations** (only visible on GitLab.com) 1. On the **Integrations** page, click **Slack application**. 1. The current **Project Alias**, if any, is displayed. To edit this value, click **Edit**. diff --git a/doc/user/project/integrations/hangouts_chat.md b/doc/user/project/integrations/hangouts_chat.md index f65b31150a9..54f9bd8d622 100644 --- a/doc/user/project/integrations/hangouts_chat.md +++ b/doc/user/project/integrations/hangouts_chat.md @@ -1,3 +1,9 @@ +--- +stage: Create +group: Ecosystem +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/#designated-technical-writers +--- + # Hangouts Chat service > [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/issues/43756) in GitLab 11.2. diff --git a/doc/user/project/integrations/hipchat.md b/doc/user/project/integrations/hipchat.md index 2ed7f13db9b..718f00273bd 100644 --- a/doc/user/project/integrations/hipchat.md +++ b/doc/user/project/integrations/hipchat.md @@ -1,3 +1,9 @@ +--- +stage: Create +group: Ecosystem +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/#designated-technical-writers +--- + # Atlassian HipChat GitLab provides a way to send HipChat notifications upon a number of events, diff --git a/doc/user/project/integrations/img/actions_menu_create_new_dashboard_v13_2.png b/doc/user/project/integrations/img/actions_menu_create_new_dashboard_v13_2.png deleted file mode 100644 index 5d530a80421..00000000000 Binary files a/doc/user/project/integrations/img/actions_menu_create_new_dashboard_v13_2.png and /dev/null differ diff --git a/doc/user/project/integrations/img/copy_link_to_chart_v12_10.png b/doc/user/project/integrations/img/copy_link_to_chart_v12_10.png deleted file mode 100644 index fc205240ea5..00000000000 Binary files a/doc/user/project/integrations/img/copy_link_to_chart_v12_10.png and /dev/null differ diff --git a/doc/user/project/integrations/img/embed_metrics_issue_template.png b/doc/user/project/integrations/img/embed_metrics_issue_template.png deleted file mode 100644 index ca39a738d5f..00000000000 Binary files a/doc/user/project/integrations/img/embed_metrics_issue_template.png and /dev/null differ diff --git a/doc/user/project/integrations/img/embedded_metrics_markdown_v12_8.png b/doc/user/project/integrations/img/embedded_metrics_markdown_v12_8.png deleted file mode 100644 index ffd34705464..00000000000 Binary files a/doc/user/project/integrations/img/embedded_metrics_markdown_v12_8.png and /dev/null differ diff --git a/doc/user/project/integrations/img/embedded_metrics_rendered_v12_8.png b/doc/user/project/integrations/img/embedded_metrics_rendered_v12_8.png deleted file mode 100644 index b024daaaa8e..00000000000 Binary files a/doc/user/project/integrations/img/embedded_metrics_rendered_v12_8.png and /dev/null differ diff --git a/doc/user/project/integrations/img/grafana_embedded.png b/doc/user/project/integrations/img/grafana_embedded.png deleted file mode 100644 index c7946aa4b10..00000000000 Binary files a/doc/user/project/integrations/img/grafana_embedded.png and /dev/null differ diff --git a/doc/user/project/integrations/img/grafana_live_embed.png b/doc/user/project/integrations/img/grafana_live_embed.png deleted file mode 100644 index 91970cd379a..00000000000 Binary files a/doc/user/project/integrations/img/grafana_live_embed.png and /dev/null differ diff --git a/doc/user/project/integrations/img/grafana_panel_v12_5.png b/doc/user/project/integrations/img/grafana_panel_v12_5.png deleted file mode 100644 index 18c17b910cd..00000000000 Binary files a/doc/user/project/integrations/img/grafana_panel_v12_5.png and /dev/null differ diff --git a/doc/user/project/integrations/img/grafana_sharing_dialog_v12_5.png b/doc/user/project/integrations/img/grafana_sharing_dialog_v12_5.png deleted file mode 100644 index fae62dd50df..00000000000 Binary files a/doc/user/project/integrations/img/grafana_sharing_dialog_v12_5.png and /dev/null differ diff --git a/doc/user/project/integrations/img/heatmap_chart_too_much_data_v_13_2.png b/doc/user/project/integrations/img/heatmap_chart_too_much_data_v_13_2.png deleted file mode 100644 index c3a391b06c7..00000000000 Binary files a/doc/user/project/integrations/img/heatmap_chart_too_much_data_v_13_2.png and /dev/null differ diff --git a/doc/user/project/integrations/img/heatmap_panel_type.png b/doc/user/project/integrations/img/heatmap_panel_type.png deleted file mode 100644 index a2b3911ec68..00000000000 Binary files a/doc/user/project/integrations/img/heatmap_panel_type.png and /dev/null differ diff --git a/doc/user/project/integrations/img/hide_embedded_metrics_v12_10.png b/doc/user/project/integrations/img/hide_embedded_metrics_v12_10.png deleted file mode 100644 index 1213029d1d1..00000000000 Binary files a/doc/user/project/integrations/img/hide_embedded_metrics_v12_10.png and /dev/null differ diff --git a/doc/user/project/integrations/img/http_proxy_access_v12_5.png b/doc/user/project/integrations/img/http_proxy_access_v12_5.png deleted file mode 100644 index 0036a916a12..00000000000 Binary files a/doc/user/project/integrations/img/http_proxy_access_v12_5.png and /dev/null differ diff --git a/doc/user/project/integrations/img/metrics_dashboard_annotations_ui_v13.0.png b/doc/user/project/integrations/img/metrics_dashboard_annotations_ui_v13.0.png deleted file mode 100644 index a042fbbcf4e..00000000000 Binary files a/doc/user/project/integrations/img/metrics_dashboard_annotations_ui_v13.0.png and /dev/null differ diff --git a/doc/user/project/integrations/img/metrics_settings_button_v13_2.png b/doc/user/project/integrations/img/metrics_settings_button_v13_2.png deleted file mode 100644 index d649f77eded..00000000000 Binary files a/doc/user/project/integrations/img/metrics_settings_button_v13_2.png and /dev/null differ diff --git a/doc/user/project/integrations/img/panel_context_menu_v13_0.png b/doc/user/project/integrations/img/panel_context_menu_v13_0.png deleted file mode 100644 index 2d7cb923981..00000000000 Binary files a/doc/user/project/integrations/img/panel_context_menu_v13_0.png and /dev/null differ diff --git a/doc/user/project/integrations/img/project_integrations_v13_3.png b/doc/user/project/integrations/img/project_integrations_v13_3.png new file mode 100644 index 00000000000..9c925d32441 Binary files /dev/null and b/doc/user/project/integrations/img/project_integrations_v13_3.png differ diff --git a/doc/user/project/integrations/img/project_services.png b/doc/user/project/integrations/img/project_services.png deleted file mode 100644 index 5fed38a349c..00000000000 Binary files a/doc/user/project/integrations/img/project_services.png and /dev/null differ diff --git a/doc/user/project/integrations/img/prometheus_add_metric.png b/doc/user/project/integrations/img/prometheus_add_metric.png deleted file mode 100644 index 9afeb535123..00000000000 Binary files a/doc/user/project/integrations/img/prometheus_add_metric.png and /dev/null differ diff --git a/doc/user/project/integrations/img/prometheus_alert.png b/doc/user/project/integrations/img/prometheus_alert.png deleted file mode 100644 index ffa1008ff51..00000000000 Binary files a/doc/user/project/integrations/img/prometheus_alert.png and /dev/null differ diff --git a/doc/user/project/integrations/img/prometheus_cluster_health_embed_v12_9.png b/doc/user/project/integrations/img/prometheus_cluster_health_embed_v12_9.png deleted file mode 100644 index c669467757f..00000000000 Binary files a/doc/user/project/integrations/img/prometheus_cluster_health_embed_v12_9.png and /dev/null differ diff --git a/doc/user/project/integrations/img/prometheus_dashboard_anomaly_panel_type.png b/doc/user/project/integrations/img/prometheus_dashboard_anomaly_panel_type.png deleted file mode 100644 index 5cba6fa9038..00000000000 Binary files a/doc/user/project/integrations/img/prometheus_dashboard_anomaly_panel_type.png and /dev/null differ diff --git a/doc/user/project/integrations/img/prometheus_dashboard_area_panel_type_v12_8.png b/doc/user/project/integrations/img/prometheus_dashboard_area_panel_type_v12_8.png deleted file mode 100644 index 8c5663fef12..00000000000 Binary files a/doc/user/project/integrations/img/prometheus_dashboard_area_panel_type_v12_8.png and /dev/null differ diff --git a/doc/user/project/integrations/img/prometheus_dashboard_bar_chart_panel_type_v12.10.png b/doc/user/project/integrations/img/prometheus_dashboard_bar_chart_panel_type_v12.10.png deleted file mode 100644 index 593e31477f4..00000000000 Binary files a/doc/user/project/integrations/img/prometheus_dashboard_bar_chart_panel_type_v12.10.png and /dev/null differ diff --git a/doc/user/project/integrations/img/prometheus_dashboard_column_panel_type.png b/doc/user/project/integrations/img/prometheus_dashboard_column_panel_type.png deleted file mode 100644 index 985f2b04ef3..00000000000 Binary files a/doc/user/project/integrations/img/prometheus_dashboard_column_panel_type.png and /dev/null differ diff --git a/doc/user/project/integrations/img/prometheus_dashboard_edit_metric_link_v_12_9.png b/doc/user/project/integrations/img/prometheus_dashboard_edit_metric_link_v_12_9.png deleted file mode 100644 index b66b1a9f39b..00000000000 Binary files a/doc/user/project/integrations/img/prometheus_dashboard_edit_metric_link_v_12_9.png and /dev/null differ diff --git a/doc/user/project/integrations/img/prometheus_dashboard_environments_v12_8.png b/doc/user/project/integrations/img/prometheus_dashboard_environments_v12_8.png deleted file mode 100644 index 467deb86881..00000000000 Binary files a/doc/user/project/integrations/img/prometheus_dashboard_environments_v12_8.png and /dev/null differ diff --git a/doc/user/project/integrations/img/prometheus_dashboard_label_variable_shorthand.png b/doc/user/project/integrations/img/prometheus_dashboard_label_variable_shorthand.png deleted file mode 100644 index 15111a97464..00000000000 Binary files a/doc/user/project/integrations/img/prometheus_dashboard_label_variable_shorthand.png and /dev/null differ diff --git a/doc/user/project/integrations/img/prometheus_dashboard_label_variables.png b/doc/user/project/integrations/img/prometheus_dashboard_label_variables.png deleted file mode 100644 index 9b94d0c6afa..00000000000 Binary files a/doc/user/project/integrations/img/prometheus_dashboard_label_variables.png and /dev/null differ diff --git a/doc/user/project/integrations/img/prometheus_dashboard_repeated_label.png b/doc/user/project/integrations/img/prometheus_dashboard_repeated_label.png deleted file mode 100644 index d43a890f0fa..00000000000 Binary files a/doc/user/project/integrations/img/prometheus_dashboard_repeated_label.png and /dev/null differ diff --git a/doc/user/project/integrations/img/prometheus_dashboard_select_v_13_0.png b/doc/user/project/integrations/img/prometheus_dashboard_select_v_13_0.png deleted file mode 100644 index 2f0309ce664..00000000000 Binary files a/doc/user/project/integrations/img/prometheus_dashboard_select_v_13_0.png and /dev/null differ diff --git a/doc/user/project/integrations/img/prometheus_dashboard_single_stat_panel_type.png b/doc/user/project/integrations/img/prometheus_dashboard_single_stat_panel_type.png deleted file mode 100644 index 2d7dfb27b49..00000000000 Binary files a/doc/user/project/integrations/img/prometheus_dashboard_single_stat_panel_type.png and /dev/null differ diff --git a/doc/user/project/integrations/img/prometheus_dashboard_stacked_column_panel_type_v12_8.png b/doc/user/project/integrations/img/prometheus_dashboard_stacked_column_panel_type_v12_8.png deleted file mode 100644 index ba67509bcf3..00000000000 Binary files a/doc/user/project/integrations/img/prometheus_dashboard_stacked_column_panel_type_v12_8.png and /dev/null differ diff --git a/doc/user/project/integrations/img/prometheus_dashboard_yaml_validation_v13_1.png b/doc/user/project/integrations/img/prometheus_dashboard_yaml_validation_v13_1.png deleted file mode 100644 index 08d7d6603d2..00000000000 Binary files a/doc/user/project/integrations/img/prometheus_dashboard_yaml_validation_v13_1.png and /dev/null differ diff --git a/doc/user/project/integrations/img/prometheus_monitoring_dashboard_v13_1.png b/doc/user/project/integrations/img/prometheus_monitoring_dashboard_v13_1.png deleted file mode 100644 index 56a0a508a1d..00000000000 Binary files a/doc/user/project/integrations/img/prometheus_monitoring_dashboard_v13_1.png and /dev/null differ diff --git a/doc/user/project/integrations/img/prometheus_service_alerts.png b/doc/user/project/integrations/img/prometheus_service_alerts.png deleted file mode 100644 index 609c5e5196c..00000000000 Binary files a/doc/user/project/integrations/img/prometheus_service_alerts.png and /dev/null differ diff --git a/doc/user/project/integrations/img/related_links_v13_1.png b/doc/user/project/integrations/img/related_links_v13_1.png deleted file mode 100644 index 4dc141f0e7f..00000000000 Binary files a/doc/user/project/integrations/img/related_links_v13_1.png and /dev/null differ diff --git a/doc/user/project/integrations/img/rendered_grafana_embed_v12_5.png b/doc/user/project/integrations/img/rendered_grafana_embed_v12_5.png deleted file mode 100644 index 6cabe4193bd..00000000000 Binary files a/doc/user/project/integrations/img/rendered_grafana_embed_v12_5.png and /dev/null differ diff --git a/doc/user/project/integrations/img/select_query_variables_v12_5.png b/doc/user/project/integrations/img/select_query_variables_v12_5.png deleted file mode 100644 index 23503577327..00000000000 Binary files a/doc/user/project/integrations/img/select_query_variables_v12_5.png and /dev/null differ diff --git a/doc/user/project/integrations/img/view_embedded_metrics_v12_10.png b/doc/user/project/integrations/img/view_embedded_metrics_v12_10.png deleted file mode 100644 index 95bb148ba71..00000000000 Binary files a/doc/user/project/integrations/img/view_embedded_metrics_v12_10.png and /dev/null differ diff --git a/doc/user/project/integrations/img/webex_teams_configuration.png b/doc/user/project/integrations/img/webex_teams_configuration.png index 66993e0887d..493b3ea50a0 100644 Binary files a/doc/user/project/integrations/img/webex_teams_configuration.png and b/doc/user/project/integrations/img/webex_teams_configuration.png differ diff --git a/doc/user/project/integrations/index.md b/doc/user/project/integrations/index.md index 75565dd2750..0a1db5da61d 100644 --- a/doc/user/project/integrations/index.md +++ b/doc/user/project/integrations/index.md @@ -1,3 +1,9 @@ +--- +stage: Create +group: Ecosystem +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/#designated-technical-writers +--- + # Project integrations You can find the available integrations under your project's diff --git a/doc/user/project/integrations/irker.md b/doc/user/project/integrations/irker.md index 2d807d4302b..f2e769dcfc0 100644 --- a/doc/user/project/integrations/irker.md +++ b/doc/user/project/integrations/irker.md @@ -1,3 +1,9 @@ +--- +stage: Create +group: Ecosystem +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/#designated-technical-writers +--- + # Irker IRC Gateway GitLab provides a way to push update messages to an Irker server. When diff --git a/doc/user/project/integrations/jira.md b/doc/user/project/integrations/jira.md index 541c65041ad..f11cd4d9539 100644 --- a/doc/user/project/integrations/jira.md +++ b/doc/user/project/integrations/jira.md @@ -1,36 +1,39 @@ +--- +stage: Create +group: Ecosystem +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/#designated-technical-writers +--- + # GitLab Jira integration -GitLab Issues are a powerful tool for discussing ideas and planning and tracking work. -However, many organizations have been using Jira for these purposes and have -extensive data and business processes built into it. +If you need to use Jira to track work that's implemented in GitLab, GitLab's Jira integrations make the process of working across systems more efficent. + +This page is about the GitLab Jira integration, which is available in every GitLab project by default, allowing you to connect it to any Jira instance, whether Cloud or self-managed. To compare features with the complementary Jira Development Panel integration, see [Jira integrations](jira_integrations.md). -While you can always migrate content and process from Jira to GitLab Issues, -you can also opt to continue using Jira and use it together with GitLab through -our integration. +After you set up this integration, you can cross-reference activity in the GitLab project with any of your projects in Jira. This includes the ability to close or transition Jira issues when work is completed in GitLab. -For a video demonstration of integration with Jira, watch [GitLab workflow with Jira issues and Jenkins pipelines](https://youtu.be/Jn-_fyra7xQ). +Features include: -Once you integrate your GitLab project with your Jira instance, you can automatically -detect and cross-reference activity between the GitLab project and any of your projects -in Jira. This includes the ability to close or transition Jira issues when the work -is completed in GitLab. +- **Mention a Jira issue ID** in a commit message or MR (merge request) and + - GitLab links to the Jira issue. + - The Jira issue adds a comment with details and a link back to the activity in GitLab. +- **Mention that a commit or MR resolves or closes a specific Jira issue** and when it's merged to the default branch: + - GitLab's MR displays a note that it closed the Jira issue. Prior to the merge, MRs indicate which issue they will close. + - The Jira issue shows the activity and is closed or otherwise transitioned as specified in your GitLab settings. +- **View a list of Jira issues directly in GitLab** **(PREMIUM)** -Here's how the integration responds when you take the following actions in GitLab: +For additional features, you can install the [Jira Development Panel integration](../../../integration/jira_development_panel.md). This enables you to: -- **Mention a Jira issue ID** in a commit message or MR (merge request). - - GitLab hyperlinks to the Jira issue. - - The Jira issue adds an issue link to the commit/MR in GitLab. - - The Jira issue adds a comment reflecting the comment made in GitLab, the comment author, and a link to the commit/MR in GitLab, unless this commenting to Jira is [disabled](#disabling-comments-on-jira-issues). -- **Mention that a commit or MR 'closes', 'resolves', or 'fixes' a Jira issue ID**. When the commit is made on the project's default branch (usually master) or the change is merged to the default branch: - - GitLab's merge request page displays a note that it "Closed" the Jira issue, with a link to the issue. (Note: Before the merge, an MR will display that it "Closes" the Jira issue.) - - The Jira issue shows the activity and the Jira issue is closed, or otherwise transitioned. +- In a Jira issue, display relevant GitLab information in the [development panel](https://support.atlassian.com/jira-software-cloud/docs/view-development-information-for-an-issue/), including related branches, commits, and merge requests. +- Use Jira [Smart Commits](https://confluence.atlassian.com/fisheye/using-smart-commits-960155400.html) in GitLab to add Jira comments, log time spent on the issue, or apply any issue transition. -You can also use [Jira's Smart Commits](https://confluence.atlassian.com/fisheye/using-smart-commits-960155400.html) -directly from GitLab, as covered in the article -[How and why to integrate GitLab with Jira](https://www.programmableweb.com/news/how-and-why-to-integrate-gitlab-jira/how-to/2017/04/25). +See the [feature comparison](jira_integrations.md#feature-comparison) for more details. ## Configuration + +For an overview, see [Agile Management - GitLab-Jira Basic Integration](https://www.youtube.com/watch?v=fWvwkx5_00E&feature=youtu.be). + Each GitLab project can be configured to connect to an entire Jira instance. That means one GitLab project can interact with _all_ Jira projects in that instance, once configured. Therefore, you will not have to explicitly associate @@ -68,7 +71,7 @@ Select **Enable integration**. Select a **Trigger** action. This determines whether a mention of a Jira issue in GitLab commits, merge requests, or both, should link the Jira issue back to that source commit/MR and transition the Jira issue, if indicated. -To include a comment on the Jira issue when the above referene is made in GitLab, check **Enable comments**. +To include a comment on the Jira issue when the above reference is made in GitLab, check **Enable comments**. Enter the further details on the page as described in the following table. @@ -80,7 +83,9 @@ Enter the further details on the page as described in the following table. | `Password/API token` |Created in [configuring Jira](#configuring-jira) step. Use `password` for **Jira Server** or `API token` for **Jira Cloud**. | | `Transition ID` | Required for closing Jira issues via commits or merge requests. This is the ID of a transition in Jira that moves issues to a desired state. (See [Obtaining a transition ID](#obtaining-a-transition-id).) If you insert multiple transition IDs separated by `,` or `;`, the issue is moved to each state, one after another, using the given order. | -To enable users to view Jira issues inside GitLab, select **Enable Jira issues** and enter a project key. **(PREMIUM)** +To enable users to view Jira issues inside the GitLab project, select **Enable Jira issues** and enter a Jira project key. **(PREMIUM)** + +You can only display issues from a single Jira project within a given GitLab project. CAUTION: **Caution:** If you enable Jira issues with the setting above, all users that have access to this GitLab project will be able to view all issues from the specified Jira project. diff --git a/doc/user/project/integrations/jira_cloud_configuration.md b/doc/user/project/integrations/jira_cloud_configuration.md index c7157b6bd0e..14999734c00 100644 --- a/doc/user/project/integrations/jira_cloud_configuration.md +++ b/doc/user/project/integrations/jira_cloud_configuration.md @@ -1,3 +1,9 @@ +--- +stage: Create +group: Ecosystem +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/#designated-technical-writers +--- + # Creating an API token in Jira Cloud An API token is needed when integrating with Jira Cloud, follow the steps diff --git a/doc/user/project/integrations/jira_integrations.md b/doc/user/project/integrations/jira_integrations.md new file mode 100644 index 00000000000..90cd9bf3acb --- /dev/null +++ b/doc/user/project/integrations/jira_integrations.md @@ -0,0 +1,35 @@ +--- +stage: Create +group: Ecosystem +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/#designated-technical-writers +--- + +# Jira integrations + +## Introduction + +GitLab Issues are a tool for discussing ideas and planning and tracking work. However, your organization may already use Jira for these purposes, with +extensive, established data and business processes they rely on. + +Although you can [migrate](../../../user/project/import/jira.md) your Jira issues and work exclusively in GitLab, you also have the option of continuing to use Jira by using GitLab's Jira integrations. + +## Integrations + +The following Jira integrations allow different types of cross-referencing between GitLab activity and Jira issues, with additional features: + +- [**Jira integration**](jira.md) - This is built in to GitLab. In a given GitLab project, it can be configured to connect to any Jira instance, self-managed or Cloud. +- [**Jira development panel integration**](../../../integration/jira_development_panel.md) **(PREMIUM)** - This connects all GitLab projects under a specified group or personal namespace. + - If you're using Jira Cloud and GitLab.com, install the [GitLab for Jira](https://marketplace.atlassian.com/apps/1221011/gitlab-for-jira) app in the Atlassian Marketplace and see its [documentation](../../../integration/jira_development_panel.md#gitlab-for-jira-app). + - For all other environments, use the [Jira DVCS Connector configuration instructions](../../../integration/jira_development_panel.md#configuration). + +### Feature comparison + +| Capability | Jira integration | Jira Development Panel integration | +|-----------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------| +| Mention of Jira issue ID in GitLab is automatically linked to that issue | Yes | No | +| Mention of Jira issue ID in GitLab issue/MR is reflected in the Jira issue | Yes, as a Jira comment with the GitLab issue/MR title and a link back to it. Its first mention also adds the GitLab page to the Jira issue under “Web links”. | Yes, in the issue’s Development panel | +| Mention of Jira issue ID in GitLab commit message is reflected in the issue | Yes. The entire commit message is added to the Jira issue as a comment and under “Web links”, each with a link 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. | +| Mention of Jira issue ID in GitLab branch names is reflected in Jira issue | No | Yes, in the issue’s Development panel | +| Record Jira time tracking info against an issue | No | Yes. Time can be specified via Jira Smart Commits. | +| Transition or close a Jira issue with a Git commit or merge request | 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 | diff --git a/doc/user/project/integrations/jira_server_configuration.md b/doc/user/project/integrations/jira_server_configuration.md index c8278a0f083..38098d7d15b 100644 --- a/doc/user/project/integrations/jira_server_configuration.md +++ b/doc/user/project/integrations/jira_server_configuration.md @@ -1,3 +1,9 @@ +--- +stage: Create +group: Ecosystem +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/#designated-technical-writers +--- + # Creating a username and password for Jira Server We need to create a user in Jira which will have access to all projects that diff --git a/doc/user/project/integrations/mattermost.md b/doc/user/project/integrations/mattermost.md index 67d60984c22..c12a969ca3c 100644 --- a/doc/user/project/integrations/mattermost.md +++ b/doc/user/project/integrations/mattermost.md @@ -1,3 +1,9 @@ +--- +stage: Create +group: Ecosystem +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/#designated-technical-writers +--- + # Mattermost Notifications Service The Mattermost Notifications Service allows your GitLab project to send events (e.g., `issue created`) to your existing Mattermost team as notifications. This requires configurations in both Mattermost and GitLab. diff --git a/doc/user/project/integrations/mattermost_slash_commands.md b/doc/user/project/integrations/mattermost_slash_commands.md index 6a202c9a130..5e08767d3f0 100644 --- a/doc/user/project/integrations/mattermost_slash_commands.md +++ b/doc/user/project/integrations/mattermost_slash_commands.md @@ -1,3 +1,9 @@ +--- +stage: Create +group: Ecosystem +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/#designated-technical-writers +--- + # Mattermost slash commands > Introduced in GitLab 8.14 @@ -42,9 +48,9 @@ the administrator console. ![Mattermost go to console](img/mattermost_goto_console.png) -1. Click **Custom integrations** and set **Enable Custom Slash Commands**, - **Enable custom integrations to override usernames**, and **Override - custom integrations to override profile picture icons** to true +1. Click **Integration Management** and set **Enable Custom Slash Commands**, + **Enable integrations to override usernames**, and **Enable + integrations to override profile picture icons** to true ![Mattermost console](img/mattermost_console_integrations.png) diff --git a/doc/user/project/integrations/microsoft_teams.md b/doc/user/project/integrations/microsoft_teams.md index 611ae1a01af..b2a2f1c3e7b 100644 --- a/doc/user/project/integrations/microsoft_teams.md +++ b/doc/user/project/integrations/microsoft_teams.md @@ -1,3 +1,9 @@ +--- +stage: Create +group: Ecosystem +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/#designated-technical-writers +--- + # Microsoft Teams service ## On Microsoft Teams diff --git a/doc/user/project/integrations/mock_ci.md b/doc/user/project/integrations/mock_ci.md index b06ccda8287..4567d345336 100644 --- a/doc/user/project/integrations/mock_ci.md +++ b/doc/user/project/integrations/mock_ci.md @@ -1,3 +1,9 @@ +--- +stage: Create +group: Ecosystem +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/#designated-technical-writers +--- + # Mock CI Service **NB: This service is only listed if you are in a development environment!** diff --git a/doc/user/project/integrations/overview.md b/doc/user/project/integrations/overview.md index 79c55e2d140..f179cd6b98e 100644 --- a/doc/user/project/integrations/overview.md +++ b/doc/user/project/integrations/overview.md @@ -1,3 +1,9 @@ +--- +stage: Create +group: Ecosystem +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/#designated-technical-writers +--- + # Integrations Integrations allow you to integrate GitLab with other applications. They @@ -12,7 +18,7 @@ You can find the available integrations under your project's There are more than 20 integrations to integrate with. Click on the one that you want to configure. -![Integrations list](img/project_services.png) +![Integrations list](img/project_integrations_v13_3.png) ## Integrations listing @@ -69,10 +75,18 @@ The number of branches or tags supported can be changed via ## Service templates -Service templates are a way to set predefined values for an integration across +Service templates are a way to set predefined values for a project integration across all new projects on the instance. -Read more about [Service templates in this document](services_templates.md). +Read more about [Service templates](services_templates.md). + +## Project integration management + +Project integraton management lets you control integration settings across all projects +of an instance. On the project level, administrators you can choose whether to inherit the +instance configuraton or provide custom settings. + +Read more about [Project integration management](../../admin_area/settings/project_integration_management.md). ## Troubleshooting integrations diff --git a/doc/user/project/integrations/prometheus.md b/doc/user/project/integrations/prometheus.md index f1567208a8f..a19b819c823 100644 --- a/doc/user/project/integrations/prometheus.md +++ b/doc/user/project/integrations/prometheus.md @@ -88,7 +88,7 @@ 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). 1. Navigate to the [Integrations page](overview.md#accessing-integrations) at - **{settings}** **Settings > Integrations**. + **Settings > Integrations**. 1. Click the **Prometheus** service. 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/`. @@ -121,7 +121,8 @@ one of them will be used: [Prometheus manual configuration](#manual-configuration-of-prometheus) and a [managed Prometheus on Kubernetes](#managed-prometheus-on-kubernetes), the manual configuration takes precedence and is used to run queries from - [dashboards](../../../operations/metrics/dashboards/index.md#defining-custom-dashboards-per-project) and [custom metrics](../../../operations/metrics/index.md#adding-custom-metrics). + [custom dashboards](../../../operations/metrics/dashboards/index.md) and + [custom metrics](../../../operations/metrics/index.md#adding-custom-metrics). - If you have managed Prometheus applications installed on Kubernetes clusters at **different** levels (project, group, instance), the order of precedence is described in [Cluster precedence](../../instance/clusters/index.md#cluster-precedence). diff --git a/doc/user/project/integrations/prometheus_library/cloudwatch.md b/doc/user/project/integrations/prometheus_library/cloudwatch.md index 911493cdae9..e278c7eb664 100644 --- a/doc/user/project/integrations/prometheus_library/cloudwatch.md +++ b/doc/user/project/integrations/prometheus_library/cloudwatch.md @@ -4,7 +4,7 @@ group: APM 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/#designated-technical-writers --- -# Monitoring AWS Resources +# Monitoring AWS resources > [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/12621) in GitLab 9.4 diff --git a/doc/user/project/integrations/redmine.md b/doc/user/project/integrations/redmine.md index c92ddf38ad2..2a85dd9b79b 100644 --- a/doc/user/project/integrations/redmine.md +++ b/doc/user/project/integrations/redmine.md @@ -1,3 +1,9 @@ +--- +stage: Create +group: Ecosystem +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/#designated-technical-writers +--- + # Redmine Service 1. To enable the Redmine integration in a project, navigate to the diff --git a/doc/user/project/integrations/services_templates.md b/doc/user/project/integrations/services_templates.md index bc2bdde2f64..688643a85a7 100644 --- a/doc/user/project/integrations/services_templates.md +++ b/doc/user/project/integrations/services_templates.md @@ -1,3 +1,9 @@ +--- +stage: Create +group: Ecosystem +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/#designated-technical-writers +--- + # Service templates Using a service template, GitLab administrators can provide default values for configuring integrations at the project level. diff --git a/doc/user/project/integrations/slack.md b/doc/user/project/integrations/slack.md index 6c5dc787c5e..03ff5f845b6 100644 --- a/doc/user/project/integrations/slack.md +++ b/doc/user/project/integrations/slack.md @@ -1,3 +1,9 @@ +--- +stage: Create +group: Ecosystem +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/#designated-technical-writers +--- + # Slack Notifications Service The Slack Notifications Service allows your GitLab project to send events @@ -19,7 +25,7 @@ separately configured [Slack slash commands](slack_slash_commands.md). 1. Open your project's page, and navigate to your project's [Integrations page](overview.md#accessing-integrations) at - **{settings}** **Settings > Integrations**. + **Settings > Integrations**. 1. Select the **Slack notifications** integration to configure it. 1. Click **Enable integration**. 1. In **Trigger**, select the checkboxes for each type of GitLab event to send to Slack as a diff --git a/doc/user/project/integrations/slack_slash_commands.md b/doc/user/project/integrations/slack_slash_commands.md index d25a367bd1f..7c2413fce81 100644 --- a/doc/user/project/integrations/slack_slash_commands.md +++ b/doc/user/project/integrations/slack_slash_commands.md @@ -1,3 +1,9 @@ +--- +stage: Create +group: Ecosystem +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/#designated-technical-writers +--- + # Slack slash commands **(CORE ONLY)** > Introduced in GitLab 8.15. diff --git a/doc/user/project/integrations/unify_circuit.md b/doc/user/project/integrations/unify_circuit.md index 98dc6f298d5..c4959a8711b 100644 --- a/doc/user/project/integrations/unify_circuit.md +++ b/doc/user/project/integrations/unify_circuit.md @@ -1,3 +1,9 @@ +--- +stage: Create +group: Ecosystem +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/#designated-technical-writers +--- + # Unify Circuit service The Unify Circuit service sends notifications from GitLab to the conversation for which the webhook was created. diff --git a/doc/user/project/integrations/webex_teams.md b/doc/user/project/integrations/webex_teams.md index 10735e33746..39daa14407f 100644 --- a/doc/user/project/integrations/webex_teams.md +++ b/doc/user/project/integrations/webex_teams.md @@ -1,3 +1,9 @@ +--- +stage: Create +group: Ecosystem +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/#designated-technical-writers +--- + # Webex Teams service You can configure GitLab to send notifications to a Webex Teams space. diff --git a/doc/user/project/integrations/webhooks.md b/doc/user/project/integrations/webhooks.md index 5a0ca03a646..800eb1d3359 100644 --- a/doc/user/project/integrations/webhooks.md +++ b/doc/user/project/integrations/webhooks.md @@ -1,23 +1,10 @@ -# Webhooks +--- +stage: Create +group: Ecosystem +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/#designated-technical-writers +--- -> **Note:** -> Starting from GitLab 8.5: -> -> - the `repository` key is deprecated in favor of the `project` key -> - the `project.ssh_url` key is deprecated in favor of the `project.git_ssh_url` key -> - the `project.http_url` key is deprecated in favor of the `project.git_http_url` key -> -> **Note:** -> Starting from GitLab 11.1, the logs of webhooks are automatically removed after -> one month. -> -> **Note:** -> Starting from GitLab 11.2: -> -> - The `description` field for issues, merge requests, comments, and wiki pages -> is rewritten so that simple Markdown image references (like -> `![](/uploads/...)`) have their target URL changed to an absolute URL. See -> [image URL rewriting](#image-url-rewriting) for more details. +# Webhooks Project webhooks allow you to trigger a URL if for example new code is pushed or a new issue is created. You can configure webhooks to listen for specific events @@ -48,7 +35,25 @@ Navigate to the webhooks page by going to your project's **Settings ➔ Webhooks**. NOTE: **Note:** -On GitLab.com, the [maximum number of webhooks](../../../user/gitlab_com/index.md#maximum-number-of-webhooks) per project, and per group, is limited. +On GitLab.com, the [maximum number of webhooks and their size](../../../user/gitlab_com/index.md#webhooks) per project, and per group, is limited. + +## Version history + +Starting from GitLab 8.5: + +- the `repository` key is deprecated in favor of the `project` key +- the `project.ssh_url` key is deprecated in favor of the `project.git_ssh_url` key +- the `project.http_url` key is deprecated in favor of the `project.git_http_url` key + +Starting from GitLab 11.1, the logs of webhooks are automatically removed after +one month. + +Starting from GitLab 11.2: + +- The `description` field for issues, merge requests, comments, and wiki pages + is rewritten so that simple Markdown image references (like + `![](/uploads/...)`) have their target URL changed to an absolute URL. See + [image URL rewriting](#image-url-rewriting) for more details. ## Use-cases @@ -722,7 +727,7 @@ X-Gitlab-Event: Note Hook "type": "ProjectLabel", "group_id": null } - ], + ] } } ``` @@ -1296,6 +1301,58 @@ X-Gitlab-Event: Job Hook Note that `commit.id` is the ID of the pipeline, not the ID of the commit. +### Deployment events + +Triggered when deployment is finished/failed/canceled. + +**Request Header**: + +```plaintext +X-Gitlab-Event: Deployment Hook +``` + +**Request Body**: + +```json +{ + "object_kind": "deployment", + "status": "success", + "deployable_id": 796, + "deployable_url": "http://10.126.0.2:3000/root/test-deployment-webhooks/-/jobs/796", + "environment": "staging", + "project": { + "id": 30, + "name": "test-deployment-webhooks", + "description": "", + "web_url": "http://10.126.0.2:3000/root/test-deployment-webhooks", + "avatar_url": null, + "git_ssh_url": "ssh://vlad@10.126.0.2:2222/root/test-deployment-webhooks.git", + "git_http_url": "http://10.126.0.2:3000/root/test-deployment-webhooks.git", + "namespace": "Administrator", + "visibility_level": 0, + "path_with_namespace": "root/test-deployment-webhooks", + "default_branch": "master", + "ci_config_path": "", + "homepage": "http://10.126.0.2:3000/root/test-deployment-webhooks", + "url": "ssh://vlad@10.126.0.2:2222/root/test-deployment-webhooks.git", + "ssh_url": "ssh://vlad@10.126.0.2:2222/root/test-deployment-webhooks.git", + "http_url": "http://10.126.0.2:3000/root/test-deployment-webhooks.git" + }, + "short_sha": "279484c0", + "user": { + "name": "Administrator", + "username": "root", + "avatar_url": "https://www.gravatar.com/avatar/e64c7d89f26bd1972efa854d13d7dd61?s=80&d=identicon", + "email": "admin@example.com" + }, + "user_url": "http://10.126.0.2:3000/root", + "commit_url": "http://10.126.0.2:3000/root/test-deployment-webhooks/-/commit/279484c09fbe69ededfced8c1bb6e6d24616b468", + "commit_title": "Add new file" +} +``` + +Note that `deployable_id` is the ID of the CI job. + ## Image URL rewriting From GitLab 11.2, simple image references are rewritten to use an absolute URL @@ -1339,7 +1396,8 @@ On this page, you can see data that GitLab sends (request headers and body) and From this page, you can repeat delivery with the same data by clicking `Resend Request` button. -> **Note:** If URL or secret token of the webhook were updated, data will be delivered to the new address. +NOTE: **Note:** +If URL or secret token of the webhook were updated, data will be delivered to the new address. ### Receiving duplicate or multiple webhook requests triggered by one event diff --git a/doc/user/project/integrations/youtrack.md b/doc/user/project/integrations/youtrack.md index e067ab6071e..d243ffc7a37 100644 --- a/doc/user/project/integrations/youtrack.md +++ b/doc/user/project/integrations/youtrack.md @@ -1,3 +1,9 @@ +--- +stage: Create +group: Ecosystem +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/#designated-technical-writers +--- + # YouTrack Service JetBrains [YouTrack](https://www.jetbrains.com/help/youtrack/standalone/YouTrack-Documentation.html) is a web-based issue tracking and project management platform. -- cgit v1.2.3