Welcome to mirror list, hosted at ThFree Co, Russian Federation.

gitlab.com/gitlab-org/gitlab-foss.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
Diffstat (limited to 'doc/project_services/mattermost_slash_commands.md')
-rw-r--r--doc/project_services/mattermost_slash_commands.md42
1 files changed, 42 insertions, 0 deletions
diff --git a/doc/project_services/mattermost_slash_commands.md b/doc/project_services/mattermost_slash_commands.md
new file mode 100644
index 00000000000..b5cfc77f54a
--- /dev/null
+++ b/doc/project_services/mattermost_slash_commands.md
@@ -0,0 +1,42 @@
+# Mattermost Commands
+
+Mattermost commands give users an extra interface to perform common operations
+from the chat environment. This allows one to, for example, create an issue as
+soon as the idea was discussed in Mattermost.
+
+## Configuration
+
+### On Mattermost
+
+On Mattermost, an administrator has to enable custom slash commands. To do this,
+log on, and go to the system console.
+
+Click **Custom integrations**, and enable the custom slash commands and don't
+forget to save your settings.
+
+![Enable custom slash commands](img/mattermost_enable_custom_commands.png)
+
+Now go back to your team page, and go the the configuration page for a new
+slash command.
+
+**Integrations** > **Slash Command** > **Add Slash Command**
+
+### On GitLab
+
+On the project you want to configure the slash commands for, go to the
+Mattermost Command service. Under settings > **Project Services**.
+
+A screen will appear with all the values you can copy to the Mattermost page you
+have just opened.
+
+![Mattermost setup instructions](img/mattermost_config_help.png)
+
+## Usage
+
+A users first interaction with the newly created slash commands will trigger an
+authorisation process. This process connects your Mattermost user with your
+GitLab user.
+
+After these steps are performed, you can start interacting with GitLab. Maybe
+start with `/your-trigger issue show 1` and see what your first issue was on
+this project!