From 0cc4c14514028bead4c668c957cbeb23f4f0f845 Mon Sep 17 00:00:00 2001 From: "Z.J. van de Weg" Date: Mon, 21 Nov 2016 14:52:29 +0100 Subject: Add screenshot in docs [ci skip] --- .../img/mattermost_config_help.png | Bin 0 -> 159971 bytes doc/project_services/mattermost_command.md | 42 --------------------- doc/project_services/mattermost_slash_commands.md | 42 +++++++++++++++++++++ doc/project_services/project_services.md | 2 +- 4 files changed, 43 insertions(+), 43 deletions(-) create mode 100644 doc/project_services/img/mattermost_config_help.png delete mode 100644 doc/project_services/mattermost_command.md create mode 100644 doc/project_services/mattermost_slash_commands.md (limited to 'doc') diff --git a/doc/project_services/img/mattermost_config_help.png b/doc/project_services/img/mattermost_config_help.png new file mode 100644 index 00000000000..d0b64c058af Binary files /dev/null and b/doc/project_services/img/mattermost_config_help.png differ diff --git a/doc/project_services/mattermost_command.md b/doc/project_services/mattermost_command.md deleted file mode 100644 index 1c455c0e891..00000000000 --- a/doc/project_services/mattermost_command.md +++ /dev/null @@ -1,42 +0,0 @@ -# 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. - -**Insert screenshot here** - -## 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! 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! diff --git a/doc/project_services/project_services.md b/doc/project_services/project_services.md index 93d558df982..57b731e297b 100644 --- a/doc/project_services/project_services.md +++ b/doc/project_services/project_services.md @@ -42,7 +42,7 @@ further configuration instructions and details. Contributions are welcome. | [Irker (IRC gateway)](irker.md) | Send IRC messages, on update, to a list of recipients through an Irker gateway | | [JIRA](jira.md) | JIRA issue tracker | | JetBrains TeamCity CI | A continuous integration and build server | -| [Mattermost Commands](mattermost_command.md) | Mattermost slash commands | +| [Mattermost Slash Commands](mattermost_slash_commands.md) | Mattermost slash commands | | PivotalTracker | Project Management Software (Source Commits Endpoint) | | Pushover | Pushover makes it easy to get real-time notifications on your Android device, iPhone, iPad, and Desktop | | [Redmine](redmine.md) | Redmine issue tracker | -- cgit v1.2.3