Update Mattermost slash commands docs to explain how to create a newline and...

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
parent 728a4b50
...@@ -61,7 +61,7 @@ the administrator console. ...@@ -61,7 +61,7 @@ the administrator console.
### Step 3. Create a new custom slash command in Mattermost ### 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 the Mattermost slash commands service in GitLab, it's time to copy these values
in a new slash command. in a new slash command.
...@@ -124,20 +124,16 @@ GitLab using the Mattermost commands. ...@@ -124,20 +124,16 @@ GitLab using the Mattermost commands.
## Available slash commands ## Available slash commands
The available slash commands so far are: The available slash commands are:
| Command | Description | Example | | 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` | | <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> |
| `/<trigger> issue show <issue-number>` | Show the issue with ID `<issue-number>` from the project that `<trigger>` is tied to. | `/trigger issue show 42` | | <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> |
| `/<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; 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 To see a list of available commands to interact with GitLab, type the
trigger word followed by `help`: trigger word followed by <kbd>help</kbd>. Example: <samp>/gitlab help</samp>
```
/my-project help
```
![Mattermost bot available commands](img/mattermost_bot_available_commands.png) ![Mattermost bot available commands](img/mattermost_bot_available_commands.png)
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment