From eb9677d454a53241cf7d8d081a595ffe66a0d6fb Mon Sep 17 00:00:00 2001 From: Ashraf Khamis <akhamis@gitlab.com> Date: Fri, 14 Jul 2023 09:50:05 +0000 Subject: [PATCH] Improve Jira and Slack docs --- doc/integration/jira/configure.md | 2 +- doc/integration/jira/connect-app.md | 4 ++-- doc/integration/jira/development_panel.md | 2 -- doc/integration/jira/issues.md | 9 +-------- doc/user/admin_area/settings/slack_app.md | 2 +- .../project/integrations/gitlab_slack_application.md | 4 ++-- 6 files changed, 7 insertions(+), 16 deletions(-) diff --git a/doc/integration/jira/configure.md b/doc/integration/jira/configure.md index d7e5272d4314..9660e0917988 100644 --- a/doc/integration/jira/configure.md +++ b/doc/integration/jira/configure.md @@ -10,7 +10,7 @@ The Jira issue integration connects one or more GitLab projects to a Jira instan ## Configure the integration -> Authentication with Jira personal access tokens was [introduced](https://gitlab.com/groups/gitlab-org/-/epics/8222) in GitLab 16.0. +> Authentication with Jira personal access tokens [introduced](https://gitlab.com/groups/gitlab-org/-/epics/8222) in GitLab 16.0. Prerequisites: diff --git a/doc/integration/jira/connect-app.md b/doc/integration/jira/connect-app.md index 75f82b5f34d1..a7cb858a8153 100644 --- a/doc/integration/jira/connect-app.md +++ b/doc/integration/jira/connect-app.md @@ -46,8 +46,8 @@ For an overview, see After you add a group, the following data is synced to Jira for all projects in that group: -- New merge requests, branches, and commits. -- Existing merge requests (GitLab 13.8 and later). +- New and existing merge requests. +- New branches and commits. - Existing branches and commits (GitLab 15.11 and later). You must delete and add any namespaces that were added to the GitLab for Jira Cloud app in GitLab 15.10 and earlier. ## Update the GitLab for Jira Cloud app diff --git a/doc/integration/jira/development_panel.md b/doc/integration/jira/development_panel.md index 5b7c05c17c6e..c444ffe8a3b3 100644 --- a/doc/integration/jira/development_panel.md +++ b/doc/integration/jira/development_panel.md @@ -6,8 +6,6 @@ info: To determine the technical writer assigned to the Stage/Group associated w # Jira development panel **(FREE)** -> [Moved](https://gitlab.com/gitlab-org/gitlab/-/issues/233149) from GitLab Premium to GitLab Free in 13.4. - You can use the Jira development panel to view GitLab activity for a Jira issue directly in Jira. To set up the Jira development panel: diff --git a/doc/integration/jira/issues.md b/doc/integration/jira/issues.md index 23e971f7a9cf..c1b61e2e5870 100644 --- a/doc/integration/jira/issues.md +++ b/doc/integration/jira/issues.md @@ -49,9 +49,6 @@ You can [disable comments](#disable-comments-on-jira-issues) on issues. ### Require associated Jira issue for merge requests to be merged **(ULTIMATE)** -> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/280766) in GitLab 13.12 [with a flag](../../administration/feature_flags.md) named `jira_issue_association_on_merge_request`. Disabled by default. -> - [Generally available](https://gitlab.com/gitlab-org/gitlab/-/issues/335280) in GitLab 14.2. Feature flag `jira_issue_association_on_merge_request` removed. - With this integration, you can prevent merge requests from being merged if they do not refer to a Jira issue. To enable this feature: @@ -134,8 +131,6 @@ Consider this example: ## View Jira issues **(PREMIUM)** -> [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/3622) in GitLab 13.2. - You can view and search issues from a selected Jira project directly in GitLab, provided your GitLab administrator [has configured the integration](configure.md#configure-the-integration). @@ -148,7 +143,7 @@ The issues are sorted by **Created date** by default, with the most recently cre - To display the most recently updated issues first, select **Updated date**. - You can [search and filter the issue list](#search-and-filter-the-issue-list). -- In GitLab 13.10 and later, you can [select an issue from the list to view the issue in GitLab](https://gitlab.com/gitlab-org/gitlab/-/issues/299832). +- You can [select an issue from the list to view the issue in GitLab](https://gitlab.com/gitlab-org/gitlab/-/issues/299832). Issues are grouped into tabs based on their [Jira status](https://confluence.atlassian.com/adminjiraserver070/defining-status-field-values-749382903.html): @@ -178,8 +173,6 @@ Enhancements to use these filters through the user interface ## Automatic issue transitions -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/55773) in GitLab 13.11. - 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: diff --git a/doc/user/admin_area/settings/slack_app.md b/doc/user/admin_area/settings/slack_app.md index e968081f1395..5aae85081ed7 100644 --- a/doc/user/admin_area/settings/slack_app.md +++ b/doc/user/admin_area/settings/slack_app.md @@ -14,7 +14,7 @@ This page contains information about administering the GitLab for Slack app for The GitLab for Slack app distributed through the Slack App Directory only works with GitLab.com. On self-managed GitLab, you can create your own copy of the GitLab for Slack app from a [manifest file](https://api.slack.com/reference/manifests#creating_apps) and configure your instance. -The app is a private one-time copy installed in your Slack workspace only and not distributed through the Slack App Directory. To have the [GitLab for Slack app](../../../user/project/integrations/gitlab_slack_application.md) on your self-managed instance, you must first enable the integration. +The app is a private one-time copy installed in your Slack workspace only and not distributed through the Slack App Directory. To have the [GitLab for Slack app](../../../user/project/integrations/gitlab_slack_application.md) on your self-managed instance, you must enable the integration. ## Create a GitLab for Slack app diff --git a/doc/user/project/integrations/gitlab_slack_application.md b/doc/user/project/integrations/gitlab_slack_application.md index aac38b0c9f8a..811315eef357 100644 --- a/doc/user/project/integrations/gitlab_slack_application.md +++ b/doc/user/project/integrations/gitlab_slack_application.md @@ -20,7 +20,7 @@ you run in Slack is run by your linked GitLab user. Prerequisites: - You must have the [appropriate permissions to add apps to your Slack workspace](https://slack.com/help/articles/202035138-Add-apps-to-your-Slack-workspace). -- On self-managed GitLab, by default this feature is not available. To make it available, ask an administrator to [enable the feature](../../admin_area/settings/slack_app.md). On GitLab.com, this feature is available. +- On self-managed GitLab, an administrator must [enable the integration](../../admin_area/settings/slack_app.md). In GitLab 15.0 and later, the GitLab for Slack app uses [granular permissions](https://medium.com/slack-developer-blog/more-precision-less-restrictions-a3550006f9c3). @@ -176,7 +176,7 @@ The following events are available for Slack notifications: ### GitLab for Slack app does not appear in the list of integrations -The GitLab for Slack app might not appear in the list of integrations. To have the GitLab for Slack app on your self-managed instance, an administrator must first [enable the integration](../../admin_area/settings/slack_app.md). On GitLab.com, the GitLab for Slack app is available by default. +The GitLab for Slack app might not appear in the list of integrations. To have the GitLab for Slack app on your self-managed instance, an administrator must [enable the integration](../../admin_area/settings/slack_app.md). On GitLab.com, the GitLab for Slack app is available by default. The GitLab for Slack app is enabled at the project level only. Support for the app at the group and instance levels is proposed in [issue 391526](https://gitlab.com/gitlab-org/gitlab/-/issues/391526). -- GitLab