paulmataruso/zulip
1
0
Fork 0
mirror of https://github.com/zulip/zulip.git synced 2025-11-05 22:43:42 +00:00
Code Issues Packages Projects Releases Wiki Activity

webhooks/taiga: Migrate docs to Markdown.

Browse Source
This commit is contained in:
Eeshan Garg
2017-06-14 01:06:35 -02:30
committed by Tim Abbott
parent 1c5d0bb0fa
commit 4a3137be97
2 changed files with 43 additions and 94 deletions
Download Patch File Download Diff File Expand all files Collapse all files

94
zerver/webhooks/taiga/doc.html
View File

@@ -1,94 +0,0 @@
<p>
Go on your {{ settings_html|safe }}, create a Taiga bot.
Please note the bot name and API key.
</p>
<p>
Since Taiga allows you to integrate services on a per
project basis, you have to perform the following steps
for <b>every project</b> that you want to send
notifications to Zulip.
</p>
<ol>
<li>
<p>Go to Admin <b>></b> Integration <b>></b> Webhooks menu.</p>
</li>
<li>
<p>Click <b>Add a new webhook</b>.</p>
</li>
<li>
<p>Fill out the form by following the instructions: </p>
<ul>
<li>
<b>Name</b> - to recognize this service, preferably <code>Zulip</code>
</li>
<li>
<b>URL</b> -
<pre>{{ external_api_uri_subdomain }}/v1/external/taiga?stream=STREAM_NAME&amp;topic=TOPIC_NAME&amp;api_key=BOT_API_KEY</pre>
<ul>
<li>
<code>STREAM_NAME</code> - The url-encoded name of
stream which you want to receive notifications.
You can use an existing Zulip stream or create a
new one for this.
</li>
<li>
<code>TOPIC_NAME</code> - The url-encoded
topic where your Taiga notifications will be
posted. (Read the notes below.)
</li>
<li><code>BOT_API_KEY</code> - API key created in Zulip.</li>
</ul>
</li>
</ul>
<p>
Remember to url-encode the stream and topic
names. E.g. spaces need to be replaced
with <code>%20</code> (e.g. so if you want your stream
to be called "My awesome project", STREAM_NAME
should be <code>My%20awesome%20project</code>).
</p>
</li>
<li>
<b>Secret key</b> - once again the API key created in Zulip.
</li>
<li>
<p>Click <b>Save</b> once you've finished filling out the form.</p>
</li>
</ol>
<p>
That's it! Your actions on Taiga should now cause
notifications on the Zulip stream you specified above.
<img class="screenshot" src="/static/images/integrations/taiga/001.png"/>
</p>
<hr/>
<p>
There are <b>two different ways</b> you may want to consider
when organizing your Taiga - Zulip integration:
</p>
<ul>
<li>
Use special Zulip stream for Taiga messages - name
it <code>Taiga</code>. (Make sure to create this stream
first!) For every integrated project, provide a new topic.
<pre>
STREAM_NAME = Taiga
TOPIC = Project</pre>
</li>
<li>
If you already have a Zulip stream for managing a project,
you can also use this existing stream and add Taiga
notifications using special topic.(Remember about
substituting spaces with <code>%20</code>).
<pre>
STREAM_NAME = My%20existing%20Zulip%20stream
TOPIC = Taiga</pre>
</li>
</ul>

43
zerver/webhooks/taiga/doc.md Normal file
View File

@@ -0,0 +1,43 @@
{!create-stream.md!}
{!create-bot-construct-url.md!}
{!append-topic.md!}
Make sure to specify the topic in the URL above. Otherwise, the
default topic `General` will be used.
Remember to URL-encode the stream and topic names in the above
URL. Spaces need to be replaced with `%20`. For instance, if
you want your stream to be called "My awesome project", it
should be encoded as `My%20awesome%20project`.
Since Taiga allows you to integrate services on a per project
basis, you have to perform the following steps for *every project*
that you want to send notifications to Zulip.
1. Go to **Admin** > **Integration** > **Webhooks** menu.
2. Click **Add a new webhook**.
3. Fill out the form by following the instructions:
* **Name** - to recognize this service, preferably `Zulip`
* **URL** - the URL we created above
* **Secret key** - once again the bot API key created in Zulip
4. Click **Save** once you've finished filling out the form.
{!congrats.md!}
![](/static/images/integrations/taiga/001.png)
There are **two different ways** you may want to consider
when organizing your Taiga - Zulip integration:
* Use a separate Zulip stream for Taiga messages - name it `taiga`
(as recommended above). For every integrated project, provide a
new topic in the URL as described above.
* If you already have a Zulip stream for managing a project,
you can also use this existing stream and provide `Taiga`
as the topic in the URL.