diff --git a/doc/user/admin_area/settings/slack_app.md b/doc/user/admin_area/settings/slack_app.md index 14a7c4a8e08d57cc9e3fca3cf26162e0204e00cd..21838c7b6be688b666c510b6f26fed521c0e841e 100644 --- a/doc/user/admin_area/settings/slack_app.md +++ b/doc/user/admin_area/settings/slack_app.md @@ -14,33 +14,36 @@ On self-managed GitLab, by default this feature is not available. To make it ava NOTE: This page contains information about administering the GitLab for Slack app for self-managed instances. For user documentation, see [GitLab for Slack app](../../../user/project/integrations/gitlab_slack_application.md). -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 [Slack app manifest file](https://api.slack.com/reference/manifests#creating_apps) and configure your instance. +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 first enable the integration. -Prerequisites: +## Create a GitLab for Slack app -- You must be at least a [workspace administrator](https://slack.com/help/articles/360018112273-Types-of-roles-in-Slack) in Slack. -- You must be [signed in](https://slack.com/signin) to your Slack workspace. +Prerequisite: -## Create a GitLab for Slack app +- You must be at least a [Slack workspace administrator](https://slack.com/help/articles/360018112273-Types-of-roles-in-Slack). To create a GitLab for Slack app: -1. On the left sidebar, expand the top-most chevron (**{chevron-down}**). -1. Select **Admin Area**. -1. On the left sidebar, select **Settings > General**. -1. Expand **GitLab for Slack app**. -1. Select **Create Slack app**. +- **In GitLab**: + + 1. On the left sidebar, expand the top-most chevron (**{chevron-down}**). + 1. Select **Admin Area**. + 1. On the left sidebar, select **Settings > General**. + 1. Expand **GitLab for Slack app**. + 1. Select **Create Slack app**. + +You're then redirected to Slack for the next steps. -You are then redirected to Slack for the next steps. In the modal that appears: +- **In Slack**: -1. Select the Slack workspace to create the app in, then select **Next**. -1. Slack displays a summary of the app for review. To view the complete manifest, select **Edit Configurations**. To go back to the review summary, select **Next**. -1. Select **Create**. -1. Close the modal by selecting **Got it**. -1. Select **Install to Workspace**. + 1. Select the Slack workspace to create the app in, then select **Next**. + 1. Slack displays a summary of the app for review. To view the complete manifest, select **Edit Configurations**. To go back to the review summary, select **Next**. + 1. Select **Create**. + 1. Select **Got it** to close the dialog. + 1. Select **Install to Workspace**. ## Configure the settings @@ -52,9 +55,9 @@ After you've [created a GitLab for Slack app](#create-a-gitlab-for-slack-app), y 1. Expand **GitLab for Slack app**. 1. Select the **Enable GitLab for Slack app** checkbox. 1. Enter the details of your GitLab for Slack app: - 1. Go to [Slack API](https://api.slack.com/apps). - 1. Select **GitLab (\<your host name\>)**. You can search to find it. - 1. Scroll to **App Credentials**. + 1. Go to [Slack API](https://api.slack.com/apps). + 1. Search for and select **GitLab (\<your host name\>)**. + 1. Scroll to **App Credentials**. 1. Select **Save changes**. ### Test your configuration @@ -74,7 +77,7 @@ When GitLab releases new features for the GitLab for Slack app, you might have t To update your copy of the GitLab for Slack app: -- In GitLab: +- **In GitLab**: 1. On the left sidebar, expand the top-most chevron (**{chevron-down}**). 1. Select **Admin Area**. @@ -82,10 +85,10 @@ To update your copy of the GitLab for Slack app: 1. Expand **GitLab for Slack app**. 1. Select **Download latest manifest file** to download `slack_manifest.json`. -- In Slack: +- **In Slack**: 1. Go to [Slack API](https://api.slack.com/apps). - 1. Select **GitLab (\<your host name\>)**. You can search to find it. + 1. Search for and select **GitLab (\<your host name\>)**. 1. On the left sidebar, select **App Manifest**. 1. Select the **JSON** tab to switch to a JSON view of the manifest. 1. Copy the contents of the `slack_manifest.json` file you've downloaded from GitLab. diff --git a/doc/user/project/integrations/gitlab_slack_application.md b/doc/user/project/integrations/gitlab_slack_application.md index 0ce36bee4c4b90d4d9e3a1b1d9533a8267017aaf..e4c2e16d1d5103bccce55fa2d682bbbab0d87ce2 100644 --- a/doc/user/project/integrations/gitlab_slack_application.md +++ b/doc/user/project/integrations/gitlab_slack_application.md @@ -41,12 +41,12 @@ To install the GitLab for Slack app from project integration settings: To update the app in your Slack workspace to the latest version, you can also select **Reinstall GitLab for Slack app**. -### From the Slack app directory **(FREE SAAS)** +### From the Slack App Directory **(FREE SAAS)** On GitLab.com, you can also install the GitLab for Slack app from the -[Slack app directory](https://slack-platform.slack.com/apps/A676ADMV5-gitlab). +[Slack App Directory](https://slack-platform.slack.com/apps/A676ADMV5-gitlab). -To install the GitLab for Slack app from the Slack app directory: +To install the GitLab for Slack app from the Slack App Directory: 1. Go to the [GitLab for Slack page](https://gitlab.com/-/profile/slack/edit). 1. Select a GitLab project to link with your Slack workspace. @@ -65,7 +65,7 @@ To update your GitLab for Slack app: The GitLab for Slack app is updated for all projects that use the integration. -Alternatively, you can [configure a new Slack integration](https://about.gitlab.com/solutions/slack/). +Alternatively, you can [configure the integration](https://about.gitlab.com/solutions/slack/) again. ## Slash commands @@ -91,7 +91,7 @@ The following slash commands are available: | `/gitlab <project> issue comment <id>` <kbd>Shift</kbd>+<kbd>Enter</kbd> `<comment>` | Adds a new comment with the comment body `<comment>` to the issue with the ID `<id>`. | | `/gitlab <project> deploy <from> to <to>` | [Deploys](#the-deploy-slash-command) from the `<from>` environment to the `<to>` environment. | | `/gitlab <project> run <job name> <arguments>` | Executes the [ChatOps](../../../ci/chatops/index.md) job `<job name>` on the default branch. | -| `/gitlab incident declare` | Opens a modal to [create a new incident from Slack](../../../operations/incident_management/slack.md) (Beta). | +| `/gitlab incident declare` | Opens a dialog to [create a new incident from Slack](../../../operations/incident_management/slack.md) (Beta). | ### The `deploy` slash command