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

integrations/hubot: Migrate docs to Markdown.

This commit is contained in:
Eeshan Garg 2017-06-21 01:26:25 -02:30 committed by showell
parent 3eeb90c599
commit 31fa2f7c6d
3 changed files with 44 additions and 49 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

48
templates/zerver/integrations/hubot.html
View File

@ -1,48 +0,0 @@
<ol>
<li>
<p>
Follow the "Getting Started with Hubot" section of the
<a href="https://hubot.github.com/docs/#getting-started-with-hubot">Hubot README</a> to create your Hubot.
You'll have a new directory from which <code>bin/hubot</code> starts a vanilla Hubot instance with the shell
backend.
</p>
</li>
<li>In your Hubot's directory, install the Zulip adapter. Run:
<pre><code>npm install --save hubot-zulip</code></pre>
</li>
<li>
<p>
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.
</p>
</li>
<li>To run Hubot locally, use:
<pre><code>HUBOT_ZULIP_SITE={{ external_api_path_subdomain }} HUBOT_ZULIP_BOT=hubot-bot@example.com HUBOT_ZULIP_API_KEY=your_key bin/hubot --adapter zulip --name "myhubot"</code></pre>
</li>
</ol>
<p>
The bot account email address and API key are passed to Hubot via environment variables
<code>HUBOT_ZULIP_BOT</code> and <code>HUBOT_ZULIP_API_KEY</code>. The <code>--name</code> parameter must match
the name you gave the bot on the settings page.
</p>
<p>
Hubot will automatically listen for commands on all public streams. You can also invite Hubot to invite-only
streams.
</p>
<p>
To test your Hubot installation, send it an @-notification with a basic command, for example
<code>@Hubot pug me</code>, which should produce a result like this:
</p>
<img class="screenshot" src="/static/images/integrations/hubot/001.png"/>
<p><a href='https://github.com/zulip/hubot-zulip'>Source code for the hubot-zulip adapter is available on GitHub</a>.
</p>
<p><a href="#hubot-integrations">Check out additional Zulip integrations available via Hubot</a></p>

43
templates/zerver/integrations/hubot.md Normal file
View File

@ -0,0 +1,43 @@
1. Follow the **Getting Started with Hubot** section of the
[Hubot README](https://hubot.github.com/docs/#getting-started-with-hubot)
to create your Hubot. You'll have a new directory from
which `bin/hubot` starts a vanilla Hubot instance with
the shell backend.
2. 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.
4. To run Hubot locally, first, set the following environment
variables by running:
```
export HUBOT_ZULIP_SITE="{{ external_api_path_subdomain }}"
export HUBOT_ZULIP_BOT="hubot-bot@example.com"
export HUBOT_ZULIP_API_KEY="your_key"
```
Then, run:
`bin/hubot --adapter zulip --name "myhubot"`
The `--name` parameter must match the name you gave the bot on
the settings page.
Hubot will automatically listen for commands on all public streams.
You can also invite Hubot to invite-only streams.
To test your Hubot installation, send it an @-notification with a
basic command, for example `@Hubot pug me`, which should produce a
result like this:
![](/static/images/integrations/hubot/001.png)
[Source code for the hubot-zulip adapter is available on GitHub][1]
[1]: https://github.com/zulip/hubot-zulip
[Check out additional Zulip integrations available via Hubot][2]
[2]: #hubot-integrations

2
zerver/lib/integrations.py
View File

@ -260,7 +260,7 @@ INTEGRATIONS = {
display_name='Google Calendar',
doc='zerver/integrations/google-calendar.md'
),
'hubot': Integration('hubot', 'hubot', doc='zerver/integrations/hubot.html'),
'hubot': Integration('hubot', 'hubot', doc='zerver/integrations/hubot.md'),
'jenkins': Integration(
'jenkins',
'jenkins',