diff --git a/static/images/integrations/bot_types_generic.png b/static/images/integrations/bot_types_generic.png new file mode 100644 index 0000000000..7c6449f662 Binary files /dev/null and b/static/images/integrations/bot_types_generic.png differ diff --git a/templates/zerver/help/include/configure-matrix-bridge.md b/templates/zerver/help/include/configure-matrix-bridge.md index fc33f1ff94..3fbd344f70 100644 --- a/templates/zerver/help/include/configure-matrix-bridge.md +++ b/templates/zerver/help/include/configure-matrix-bridge.md @@ -1,8 +1,7 @@ ### Configure the bridge -1. In Zulip, [create a bot](/help/add-a-bot-or-integration), using **Generic bot** - for the bot type. Download the bot's `zuliprc` configuration file to your - computer. +1. {!create-a-generic-bot.md!} + Download the bot's `zuliprc` configuration file to your computer. 1. [Subscribe the bot](/help/add-or-remove-users-from-a-stream) to the Zulip stream that will contain the mirror. diff --git a/templates/zerver/help/include/create-a-generic-bot.md b/templates/zerver/help/include/create-a-generic-bot.md new file mode 100644 index 0000000000..3c3562f979 --- /dev/null +++ b/templates/zerver/help/include/create-a-generic-bot.md @@ -0,0 +1,5 @@ +[Create a bot](/help/add-a-bot-or-integration) for +{{ integration_display_name }}. Make sure that you select +**Generic bot** as the **Bot type**: + +![](/static/images/integrations/bot_types_generic.png) diff --git a/templates/zerver/integrations/errbot.md b/templates/zerver/integrations/errbot.md index 1aacd590bf..0146090d7f 100644 --- a/templates/zerver/integrations/errbot.md +++ b/templates/zerver/integrations/errbot.md @@ -1,19 +1,18 @@ Run your favorite chatbot in Zulip! -0. [Install errbot](https://errbot.readthedocs.io/en/latest/user_guide/setup.html) +1. [Install errbot](https://errbot.readthedocs.io/en/latest/user_guide/setup.html) and follow to instructions to set up a `config.py`. -0. Check out our [Errbot integration package for Zulip](https://github.com/zulip/errbot-backend-zulip). +1. Check out our [Errbot integration package for Zulip](https://github.com/zulip/errbot-backend-zulip). Clone this repository somewhere convenient. -0. Install the requirements listed in `errbot-backend-zulip/requirements.txt`. +1. Install the requirements listed in `errbot-backend-zulip/requirements.txt`. -0. Next, on your {{ settings_html|safe }}, [create a bot](/help/add-a-bot-or-integration) for - {{ integration_display_name }}. Make sure that you select **Generic bot** as the **Bot type**. +1. {!create-a-generic-bot.md!} -0. Download your Zulip bot's `zuliprc` config file. You will need its content for the next step. +1. Download your Zulip bot's `zuliprc` config file. You will need its content for the next step. -0. Edit your ErrBot's `config.py`. Use the following template for a minimal configuration: +1. Edit your ErrBot's `config.py`. Use the following template for a minimal configuration: import logging @@ -37,7 +36,7 @@ Run your favorite chatbot in Zulip! Sections you need to edit are marked with `<>`. -7. [Start ErrBot](https://errbot.readthedocs.io/en/latest/user_guide/setup.html#starting-the-daemon). +1. [Start ErrBot](https://errbot.readthedocs.io/en/latest/user_guide/setup.html#starting-the-daemon). {!congrats.md!} diff --git a/templates/zerver/integrations/hubot.md b/templates/zerver/integrations/hubot.md index 00de09bf72..d27350d8b7 100644 --- a/templates/zerver/integrations/hubot.md +++ b/templates/zerver/integrations/hubot.md @@ -4,14 +4,14 @@ which `bin/hubot` starts a vanilla Hubot instance with the shell backend. -2. In your Hubot's directory, install the Zulip adapter. Run: +1. In your Hubot's directory, install the Zulip adapter. Run: `npm install --save hubot-zulip` -3. On your {{ settings_html|safe }}, create a bot account. Note - its username, API key and full name; you will use them on the - next step. +1. {!create-a-generic-bot.md!} + Note its username, API key and full name; you will use them + on the next step. -4. To run Hubot locally, first, set the following environment +1. To run Hubot locally, first, set the following environment variables by running: ``` diff --git a/templates/zerver/integrations/irc.md b/templates/zerver/integrations/irc.md index 10f29f46e0..9af3b91d80 100644 --- a/templates/zerver/integrations/irc.md +++ b/templates/zerver/integrations/irc.md @@ -28,9 +28,8 @@ Mirror an IRC channel in Zulip! ### Configure the bridge -1. In Zulip, [create a bot](/help/add-a-bot-or-integration), using **Generic bot** - for the bot type. Download the bot's `zuliprc` configuration file to your - computer. +1. {!create-a-generic-bot.md!} + Download the bot's `zuliprc` configuration file to your computer. 1. [Subscribe the bot](/help/add-or-remove-users-from-a-stream) to the Zulip stream that will contain the mirror.