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

webhooks/papertrail: Migrate docs to Markdown.

This commit is contained in:
Eeshan Garg 2017-06-01 23:44:07 -02:30 committed by Tim Abbott
parent 5d868b1612
commit 829491fde7
3 changed files with 28 additions and 45 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
tools/lint
View File

@ -598,6 +598,7 @@ def build_custom_checkers(by_lang):
"zerver/webhooks/helloworld/doc.md",
"zerver/webhooks/solano/doc.md",
"zerver/webhooks/trello/doc.md",
"zerver/webhooks/papertrail/doc.md",
}
for fn in by_lang['md']:
max_length = None

45
zerver/webhooks/papertrail/doc.html
View File

@ -1,45 +0,0 @@
<p>
Zulip supports integration with Papertrail as a
<a href="http://www.perforce.com/perforce/doc.current/manuals/p4sag/chapter.scripting.html">Webhook</a>
that fires upon finding a certain log. To do this:
</p>
<p>
First, create the stream you'd like to use for Papertrail
notifications, and subscribe all interested parties to this stream. We
recommend the stream name be <code>papertrail</code>. After create a bot named
<code>Papertrail</code> and note the API key.
</p>
<p>
Next, log into your Papertrail Account and browse through your logs.
Search for logs you want to get alerts for and press the <code>Save Search</code>
to open up a modal window, then fill out the details and press the
<code>Save & Setup an alert button</code>.
</p>
<img class="screenshot" src="/static/images/integrations/papertrail/000.png"/>
<img class="screenshot" src="/static/images/integrations/papertrail/001.png"/>
<p>
Go to the <code>Create an alert</code> section, press the <code>Webhooks</code>
link and place the below URL into the <code>Webhook URL</code> section. Be sure to set
the frequency to either minute, hour or day.
</p>
<p><code>{{ external_api_uri_subdomain }}/v1/external/papertrail?api_key=abcdefgh&amp;stream=papertrail</code></p>
<img class="screenshot" src="/static/images/integrations/papertrail/002.png"/>
<p>
Note: <code>api_key</code> is the API key of your Zulip bot,
and <code>stream</code> is the stream name you want the
notifications sent to.
</p>
<p>
<b>Congratulations! You're done!</b><br/> Your Papertrail notifications will
appear in Zulip:
</p>
<img class="screenshot" src="/static/images/integrations/papertrail/003.png"/>

27
zerver/webhooks/papertrail/doc.md Normal file
View File

@ -0,0 +1,27 @@
Zulip supports integration with Papertrail as a
[Webhook](http://www.perforce.com/perforce/doc.current/manuals/p4sag/chapter.scripting.html)
that fires upon finding a certain log. To do this:
{!create-stream.md!}
{!create-bot-construct-url.md!}
Next, log into your Papertrail Account and browse through
your logs. Search for logs you want to get alerts for and press
**Save Search** to open up a modal window, then fill out the
details and press the **Save & Setup an Alert** button.
![](/static/images/integrations/papertrail/000.png)
![](/static/images/integrations/papertrail/001.png)
Go to the **Create an alert** section, press the **Webhooks**
link and place the URL created above into the **Webhook URL**
section. Be sure to set the frequency to either minute, hour or
day.
![](/static/images/integrations/papertrail/002.png)
{!congrats.md!}
![](/static/images/integrations/papertrail/003.png)