summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorSean Packham <sean@seanpackham.com>2016-12-22 18:34:43 +0000
committerSean Packham <sean@seanpackham.com>2016-12-22 18:34:43 +0000
commit0a449409d8fa6bb3c2bebdfff150b88565fa71a9 (patch)
tree0c9931734cc3d1b6ced2810928a5875d0b515d3c
parenta14a2f0f04861a08aa5829da4205d70faf5b57fa (diff)
parent4b203877bd66eb811918acd4871e61148306c630 (diff)
downloadgitlab-ce-0a449409d8fa6bb3c2bebdfff150b88565fa71a9.tar.gz
Merge branch 'zj-slack-docs' into 'master'
Slack docs [ci skip] See merge request !8269
-rw-r--r--doc/integration/chat_commands.md14
-rw-r--r--doc/project_services/img/slack_setup.pngbin0 -> 126412 bytes
-rw-r--r--doc/project_services/slack_slash_commands.md23
3 files changed, 37 insertions, 0 deletions
diff --git a/doc/integration/chat_commands.md b/doc/integration/chat_commands.md
new file mode 100644
index 00000000000..4b0084678d9
--- /dev/null
+++ b/doc/integration/chat_commands.md
@@ -0,0 +1,14 @@
+# Chat Commands
+
+Chat commands allow user to perform common operations on GitLab right from there chat client.
+Right now both Mattermost and Slack are supported.
+
+## Available commands
+
+The trigger is configurable, but for the sake of this example, we'll use `/trigger`
+
+* `/trigger help` - Displays all available commands for this user
+* `/trigger issue new <title> <shift+return> <description>` - creates a new issue on the project
+* `/trigger issue show <id>` - Shows the issue with the given ID, if you've got access
+* `/trigger issue search <query>` - Shows a maximum of 5 items matching the query
+* `/trigger deploy <from> to <to>` - Deploy from an environment to another
diff --git a/doc/project_services/img/slack_setup.png b/doc/project_services/img/slack_setup.png
new file mode 100644
index 00000000000..f69817f2b78
--- /dev/null
+++ b/doc/project_services/img/slack_setup.png
Binary files differ
diff --git a/doc/project_services/slack_slash_commands.md b/doc/project_services/slack_slash_commands.md
new file mode 100644
index 00000000000..b6b5c741d90
--- /dev/null
+++ b/doc/project_services/slack_slash_commands.md
@@ -0,0 +1,23 @@
+# Slack slash commands
+
+> Introduced in GitLab 8.15
+
+Slack 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 chat.
+For all available commands try the help subcommand, for example: `/gitlab help`,
+all review the [full list of commands](../integrations/chat_commands.md).
+
+## Prerequisites
+
+A [team](https://get.slack.help/hc/en-us/articles/217608418-Creating-a-team) in Slack should be created beforehand, GitLab cannot create it for you.
+
+## Configuration
+
+First, navigate to the Slack Slash commands service page, found at your project's
+**Settings** > **Services**, and you find the instructions there:
+
+ ![Slack setup instructions](img/slack_setup.png)
+
+Once you've followed the instructions, mark the service as active and insert the token
+you've received from Slack. After saving the service you are good to go!