Mirror
/
zulip
mirror of https://github.com/zulip/zulip.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

integrations: Add generic bot macro to relevant docs. 

There are a handful of integration docs that instruct users to create
a bot and select the "Generic bot" type without using a helper macro.

Adds a new macro to replace these instructions, including a screenshot
of the latest UI for selecting a bot type.
This commit is contained in:
David Rosa 2022-09-08 20:23:45 -04:00 committed by Tim Abbott
parent 620854d437
commit 33a618d169
6 changed files with 21 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

BIN
static/images/integrations/bot_types_generic.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 60 KiB

5
templates/zerver/help/include/configure-matrix-bridge.md
View File

@ -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.

5
templates/zerver/help/include/create-a-generic-bot.md Normal file
View File

@ -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)

15
templates/zerver/integrations/errbot.md
View File

@ -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!}

10
templates/zerver/integrations/hubot.md
View File

@ -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:
```

5
templates/zerver/integrations/irc.md
View File

@ -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.