From 456e2ace9bf6a61485263d2430a791801f80107c Mon Sep 17 00:00:00 2001 From: Dmitry Khomutov Date: Sun, 27 May 2018 12:56:01 +0700 Subject: [PATCH] Added information about additional dependencies for some plugins (Hipchat, Slack and Flowdock). --- docs/en/README.md | 2 +- docs/en/plugins/flowdock_notify.md | 14 ++++++++++++++ docs/en/plugins/hipchat_notify.md | 10 ++++++---- docs/en/plugins/slack_notify.md | 11 ++++++++++- 4 files changed, 31 insertions(+), 6 deletions(-) create mode 100644 docs/en/plugins/flowdock_notify.md diff --git a/docs/en/README.md b/docs/en/README.md index 963bb57f..02b8c982 100644 --- a/docs/en/README.md +++ b/docs/en/README.md @@ -78,7 +78,7 @@ Plugins * [Campfire](plugins/campfire.md) - `campfire` * [Email](plugins/email.md) - `email` -* FlowDock - `flowdock_notify` +* [FlowDock](plugins/flowdock_notify.md) - `flowdock_notify` * [HipChat](plugins/hipchat_notify.md) - `hipchat_notify` * [IRC](plugins/irc.md) - `irc` * [Slack](plugins/slack_notify.md) - `slack_notify` diff --git a/docs/en/plugins/flowdock_notify.md b/docs/en/plugins/flowdock_notify.md new file mode 100644 index 00000000..aa18edfa --- /dev/null +++ b/docs/en/plugins/flowdock_notify.md @@ -0,0 +1,14 @@ +Plugin FlowdockNotify +===================== + +This plugin joins a [Flowdock](https://www.flowdock.com/) room and sends a user-defined message, for example a +"Build Succeeded" message. + +Installation +------------ + +The plugin depends on `mremi/flowdock` library. To use FlowdockNotify plugin you should install dependency: + +``` +composer require "mremi/flowdock" +``` diff --git a/docs/en/plugins/hipchat_notify.md b/docs/en/plugins/hipchat_notify.md index 392a5a13..d83ece35 100644 --- a/docs/en/plugins/hipchat_notify.md +++ b/docs/en/plugins/hipchat_notify.md @@ -1,13 +1,15 @@ -Plugin Hipchat Notify +Plugin HipchatNotify ===================== This plugin joins a [HipChat](https://www.hipchat.com/) room and sends a user-defined message, for example a "Build Succeeded" message. -Install via Composer --------------------- +Installation +------------ + +The plugin depends on `hipchat/hipchat-php` library. To use HipchatNotify plugin you should install dependency: + ``` -cd /var/www/php-censor composer require "hipchat/hipchat-php" ``` diff --git a/docs/en/plugins/slack_notify.md b/docs/en/plugins/slack_notify.md index 07222902..259c5c79 100644 --- a/docs/en/plugins/slack_notify.md +++ b/docs/en/plugins/slack_notify.md @@ -1,9 +1,18 @@ -Plugin Slack Notify +Plugin SlackNotify =================== This plugin joins a [Slack](https://www.slack.com/) room and sends a user-defined message, for example a "Build Succeeded" message. +Installation +------------ + +The plugin depends on `maknz/slack` library. To use SlackNotify plugin you should install dependency: + +``` +composer require "maknz/slack" +``` + Configuration -------------