summaryrefslogtreecommitdiff
path: root/doc/project_services
diff options
context:
space:
mode:
authorAchilleas Pipinellis <axilleas@axilleas.me>2016-07-19 19:33:02 +0300
committerAchilleas Pipinellis <axilleas@axilleas.me>2016-07-22 12:37:05 +0300
commita93323cd9449ec59464727c7758401d25c4801d4 (patch)
tree9ca0567d1953ed565dd5fd4b7f1aac325d64294d /doc/project_services
parentcbe787c5872318befb9d3cbd2918a44878e04497 (diff)
downloadgitlab-ce-a93323cd9449ec59464727c7758401d25c4801d4.tar.gz
Refactor Slack service documentation
[ci skip]
Diffstat (limited to 'doc/project_services')
-rw-r--r--doc/project_services/img/slack_configuration.pngbin72072 -> 75762 bytes
-rw-r--r--doc/project_services/slack.md52
2 files changed, 38 insertions, 14 deletions
diff --git a/doc/project_services/img/slack_configuration.png b/doc/project_services/img/slack_configuration.png
index d3ebe5969af..b8de8a56db7 100644
--- a/doc/project_services/img/slack_configuration.png
+++ b/doc/project_services/img/slack_configuration.png
Binary files differ
diff --git a/doc/project_services/slack.md b/doc/project_services/slack.md
index 4ed33838f7c..3cfe77c9f85 100644
--- a/doc/project_services/slack.md
+++ b/doc/project_services/slack.md
@@ -1,26 +1,50 @@
# Slack Service
-Go to your project's **Settings > Services > Slack** and you will see a checkbox with the following events that can be triggered:
+## On Slack
-* Push
-* Issue
-* Merge request
-* Note
-* Tag push
-* Build
-* Wiki page
+To enable Slack integration you must create an incoming webhook integration on
+Slack:
-Below each of these event checkboxes you will have an input to insert which Slack channel do you want to send that event message,
-`#general` channel is default.
+1. [Sign in to Slack](https://slack.com/signin)
+1. Visit [Incoming WebHooks](https://my.slack.com/services/new/incoming-webhook/)
+1. Choose the channel name you want to send notifications to.
+1. Click **Add Incoming WebHooks Integration**
+1. Copy the **Webhook URL**, we'll need this later for GitLab.
+## On GitLab
-![Slack configuration](img/slack_configuration.png)
+After you set up Slack, it's time to set up GitLab.
+
+Go to your project's **Settings > Services > Slack** and you will see a
+checkbox with the following events that can be triggered:
+
+- Push
+- Issue
+- Merge request
+- Note
+- Tag push
+- Build
+- Wiki page
+
+Bellow each of these event checkboxes, you will have an input field to insert
+which Slack channel you want to send that event message, with `#general`
+being the default. Enter your preferred channel **without** the hash sign (`#`).
+At the end, fill in your Slack details:
| Field | Description |
| ----- | ----------- |
-| `Webhook` | The incoming webhook url which you have to setup on slack. (https://my.slack.com/services/new/incoming-webhook/) |
-| `Username` | Optional username which can be on messages sent to slack. |
-| `notify only broken builds` | Notify only about broken builds, when build events are marked to be sent.|
+| **Webhook** | The [incoming webhook URL][slackhook] which you have to setup on Slack. |
+| **Username** | Optional username which can be on messages sent to slack. Fill this in if you want to change the username of the bot. |
+| **Notify only broken builds** | If you choose to enable the **Build** event and you want to be only notified about failed builds. |
+After you are all done, click **Save changes** for the changes to take effect.
+
+>**Note:**
+You can set "branch,pushed,Compare changes" as highlight words on your Slack
+profile settings, so that you can be aware of new commits when somebody pushes
+them.
+
+![Slack configuration](img/slack_configuration.png)
+[slackhook]: https://my.slack.com/services/new/incoming-webhook