diff options
author | blackst0ne <blackst0ne.ru@gmail.com> | 2018-11-05 12:28:08 +1100 |
---|---|---|
committer | blackst0ne <blackst0ne.ru@gmail.com> | 2018-11-05 12:28:08 +1100 |
commit | 71e90802ff92e93f12fbe28f376e1b365ca3679b (patch) | |
tree | 3f69ea4d3eef7f6e04c2df403aaf2ccb63e4ae81 | |
parent | 6a4236da9bea129132df2b855c1a916488514818 (diff) | |
download | gitlab-ce-71e90802ff92e93f12fbe28f376e1b365ca3679b.tar.gz |
Update documentation
-rw-r--r-- | doc/user/project/integrations/discord_notifications.md | 30 | ||||
-rw-r--r-- | doc/user/project/integrations/img/discord_notifications_configuration.png | bin | 0 -> 110528 bytes | |||
-rw-r--r-- | doc/user/project/integrations/project_services.md | 1 |
3 files changed, 31 insertions, 0 deletions
diff --git a/doc/user/project/integrations/discord_notifications.md b/doc/user/project/integrations/discord_notifications.md new file mode 100644 index 00000000000..99b52d7aa17 --- /dev/null +++ b/doc/user/project/integrations/discord_notifications.md @@ -0,0 +1,30 @@ +# Discord Notifications service + +> [Introduced](https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/22684) in GitLab 11.5. + +The Discord Notifications service sends notifications from GitLab to the channel for which the webhook was created. + +## On Discord + +1. Open the channel in which you want to see the notifications. +1. From the channel menu, select **Edit channel**. +1. Click on **Webhooks** menu item. +1. Click on **Create Webhook** and fill in the name of the bot that will post the messages. Optionally define avatar. +1. Copy the **WEBHOOK URL** of your webhook and click **Save**. + +See also [Intro to Webhooks](https://support.discordapp.com/hc/en-us/articles/228383668-Intro-to-Webhooks) article. + +## On GitLab + +When you have the **Webhook URL** for your Discord Notifications channel webhook, you can set up the GitLab service. + +1. Navigate to the [Integrations page](project_services.md#accessing-the-project-services) in your project's settings, i.e. **Project > Settings > Integrations**. +1. Select the **Discord Notifications** project service to configure it. +1. Check the **Active** checkbox to turn on the service. +1. Check the checkboxes corresponding to the GitLab events you want to receive. +1. Paste the **Webhook URL** that you copied from the Discord Notifications configuration step. +1. Configure the remaining options and click `Save changes`. + +Your Discord Notifications channel will now start receiving GitLab event notifications as configured. + +![Discord configuration](img/discord_notifications_configuration.png) diff --git a/doc/user/project/integrations/img/discord_notifications_configuration.png b/doc/user/project/integrations/img/discord_notifications_configuration.png Binary files differnew file mode 100644 index 00000000000..e1a023fd19b --- /dev/null +++ b/doc/user/project/integrations/img/discord_notifications_configuration.png diff --git a/doc/user/project/integrations/project_services.md b/doc/user/project/integrations/project_services.md index efb0381d7aa..be45ce46dfd 100644 --- a/doc/user/project/integrations/project_services.md +++ b/doc/user/project/integrations/project_services.md @@ -30,6 +30,7 @@ Click on the service links to see further configuration instructions and details | [Bugzilla](bugzilla.md) | Bugzilla issue tracker | | Campfire | Simple web-based real-time group chat | | Custom Issue Tracker | Custom issue tracker | +| [Discord Notifications](discord_notifications.md) | Receive event notifications in Discord | | Drone CI | Continuous Integration platform built on Docker, written in Go | | [Emails on push](emails_on_push.md) | Email the commits and diff of each push to a list of recipients | | External Wiki | Replaces the link to the internal wiki with a link to an external wiki | |