diff options
author | Felipe Artur <felipefac@gmail.com> | 2016-07-12 23:00:49 +0300 |
---|---|---|
committer | Felipe Artur <felipefac@gmail.com> | 2016-07-20 02:59:00 +0300 |
commit | ede048b930b2ceb89013793d878524eb20248d1f (patch) | |
tree | 4650debc2eaefa36fef4636efc60cdb60ae47fa5 /doc | |
parent | 8bd520d70e035cd67d19b7962911ae9c31d1ff3d (diff) |
Add project service documentation and update integration documentation
Diffstat (limited to 'doc')
-rw-r--r-- | doc/integration/slack.md | 5 | ||||
-rw-r--r-- | doc/project_services/img/slack_configuration.png | bin | 0 -> 67350 bytes | |||
-rw-r--r-- | doc/project_services/project_services.md | 2 | ||||
-rw-r--r-- | doc/project_services/slack.md | 26 |
4 files changed, 29 insertions, 4 deletions
diff --git a/doc/integration/slack.md b/doc/integration/slack.md index f6ba80f46d5..8dc6c4a24bb 100644 --- a/doc/integration/slack.md +++ b/doc/integration/slack.md @@ -26,14 +26,13 @@ After Slack is ready we need to setup GitLab. Here are the steps to achieve this 1. Navigate to Settings -> Services -> Slack -1. Pick the triggers you want to activate +1. Pick the triggers you want to activate and respective channel(#general by default). 1. Fill in your Slack details - Webhook: Paste the Webhook URL from the step above - Username: Fill this in if you want to change the username of the bot - - Channel: Fill this in if you want to change the channel where the messages will be posted - Mark it as active - + 1. Save your settings Have fun :) diff --git a/doc/project_services/img/slack_configuration.png b/doc/project_services/img/slack_configuration.png Binary files differnew file mode 100644 index 00000000000..0cc672c47c9 --- /dev/null +++ b/doc/project_services/img/slack_configuration.png diff --git a/doc/project_services/project_services.md b/doc/project_services/project_services.md index e15d5db3253..4442b7c1742 100644 --- a/doc/project_services/project_services.md +++ b/doc/project_services/project_services.md @@ -45,7 +45,7 @@ further configuration instructions and details. Contributions are welcome. | 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 | -| Slack | A team communication tool for the 21st century | +| [Slack](slack.md) | A team communication tool for the 21st century | ## Services Templates diff --git a/doc/project_services/slack.md b/doc/project_services/slack.md new file mode 100644 index 00000000000..1503d9cd983 --- /dev/null +++ b/doc/project_services/slack.md @@ -0,0 +1,26 @@ +# Slack Service + +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 a input to insert which Slack channel do you want to send that event message, +#general channel is default. + + +![Slack configuration](img/slack_configuration.png) + + +| 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.| + + |