summaryrefslogtreecommitdiff
path: root/doc/project_services
diff options
context:
space:
mode:
authorPedro Moreira da Silva <pedro@gitlab.com>2016-11-30 16:30:03 +0000
committerPedro Moreira da Silva <pedro@gitlab.com>2016-12-15 13:10:19 +0000
commitef7fd97901c3f3820f08f93f97dd8fdbf0616648 (patch)
tree1b26ef918d00fdd01920e0109659ab867bfddadf /doc/project_services
parent6342ca367a32e55ec6b5ef8b3e8f9e13387b6615 (diff)
downloadgitlab-ce-ef7fd97901c3f3820f08f93f97dd8fdbf0616648.tar.gz
Update Mattermost slash commands docs to explain how to create a newline and use <kbd> for user input.
See HTML5 spec: https://www.w3.org/TR/html5/text-level-semantics.html#the-kbd-element
Diffstat (limited to 'doc/project_services')
-rw-r--r--doc/project_services/mattermost_slash_commands.md18
1 files changed, 7 insertions, 11 deletions
diff --git a/doc/project_services/mattermost_slash_commands.md b/doc/project_services/mattermost_slash_commands.md
index 6fcbf6f1642..a4d2618e567 100644
--- a/doc/project_services/mattermost_slash_commands.md
+++ b/doc/project_services/mattermost_slash_commands.md
@@ -65,7 +65,7 @@ the administrator console.
### Step 3. Create a new custom slash command in Mattermost
-Now that you have enabled the custom slash commands in Mattermost and opened
+Now that you have enabled custom slash commands in Mattermost and opened
the Mattermost slash commands service in GitLab, it's time to copy these values
in a new slash command.
@@ -128,20 +128,16 @@ GitLab using the Mattermost commands.
## Available slash commands
-The available slash commands so far are:
+The available slash commands are:
| Command | Description | Example |
| ------- | ----------- | ------- |
-| `/<trigger> issue create <title>\n<description>` | Create a new issue in the project that `<trigger>` is tied to. `<description>` is optional. | `/trigger issue create We need to change the homepage` |
-| `/<trigger> issue show <issue-number>` | Show the issue with ID `<issue-number>` from the project that `<trigger>` is tied to. | `/trigger issue show 42` |
-| `/<trigger> deploy <environment> to <environment>` | Start the CI job that deploys from one environment to another, for example `staging` to `production`. CI/CD must be [properly configured][ciyaml]. | `/trigger deploy staging to production` |
+| <kbd>/&lt;trigger&gt; issue create &lt;title&gt; **Shift** + **Enter** &lt;description&gt;</kbd> | Create a new issue in the project that `<trigger>` is tied to. `<description>` is optional. | <samp>/gitlab issue create We need to change the homepage</samp> |
+| <kbd>/&lt;trigger&gt; issue show &lt;issue-number&gt;</kbd> | Show the issue with ID `<issue-number>` from the project that `<trigger>` is tied to. | <samp>/gitlab issue show 42</samp> |
+| <kbd>/&lt;trigger&gt; deploy &lt;environment&gt; to &lt;environment&gt;</kbd> | Start the CI job that deploys from one environment to another, for example `staging` to `production`. CI/CD must be [properly configured][ciyaml]. | <samp>/gitlab deploy staging to production</samp> |
-To see a list of available commands that can interact with GitLab, type the
-trigger word followed by `help`:
-
-```
-/my-project help
-```
+To see a list of available commands to interact with GitLab, type the
+trigger word followed by <kbd>help</kbd>. Example: <samp>/gitlab help</samp>
![Mattermost bot available commands](img/mattermost_bot_available_commands.png)