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

webhooks/appfollow: Migrate docs to Markdown.

Browse Source
This commit is contained in:
Eeshan Garg
2017-05-14 22:12:23 -02:30
committed by Tim Abbott
parent 0b5711aa7e
commit 21e0db03e1
3 changed files with 25 additions and 40 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
tools/lint
View File

@@ -583,6 +583,7 @@ def build_custom_checkers(by_lang):
"docs/readme-symlink.md", "docs/readme-symlink.md",
"README.md", "README.md",
"zerver/webhooks/airbrake/doc.md", "zerver/webhooks/airbrake/doc.md",
"zerver/webhooks/appfollow/doc.md",
"zerver/webhooks/trello/doc.md", "zerver/webhooks/trello/doc.md",
} }
for fn in by_lang['md']: for fn in by_lang['md']:

40
zerver/webhooks/appfollow/doc.html
View File

@@ -1,40 +0,0 @@
<p>
Receive user reviews from your tracked apps on AppFolllow in Zulip
using the Zulip AppFollow plugin!
</p>
<p>
First, create the stream you'd like to use for AppFollow notifications, and
subscribe all interested parties to this stream. We recommend the
name <code>appfollow</code>.
</p>
<p>Next, on your {{ settings_html|safe }}, create an AppFollow bot.</p>
<p>Then, log into your account on <a href="http://appfollow.io">appfollow.io</a>, and:</p>
<ol>
<li>
<p>
Click on the app for which you'd like to receive reviews.
Click on <b>Integrations</b> and then go to the <b>Others</b> tab.
</p>
<img class="screenshot" src="/static/images/integrations/appfollow/001.png"/>
</li>
<li>
<p>
In the Webhook URL field, enter the following URL, replacing the bot API key
and Zulip stream with the appropriate information.
</p>
<p><code>{{ external_api_uri_subdomain }}/v1/external/appfollow?api_key=<font color="#00A26F">test_api_key</font>&amp;stream=<font color="#00A26F">appfollow</font></code></p>
</li>
</ol>
<p>
<b>Save changes</b> – all done!<br/>
New reviews for your app will be delivered to your Zulip stream.
</p>
<img class="screenshot" src="/static/images/integrations/appfollow/002.png"/>

24
zerver/webhooks/appfollow/doc.md Normal file
View File

@@ -0,0 +1,24 @@
Receive user reviews from your tracked apps on AppFolllow in Zulip
using the Zulip AppFollow plugin!
First, create the stream you'd like to use for AppFollow notifications, and
subscribe all interested parties to this stream. We recommend the
name `appfollow`.
Next, on your {{ settings_html|safe }}, create an AppFollow bot.
Then, log into your account on [appfollow.io](http://appfollow.io), and:
1. Click on the app for which you'd like to receive reviews.
Click on **Integrations** and then go to the **Others** tab.
![](/static/images/integrations/appfollow/001.png)
2. In the Webhook URL field, enter the following URL, replacing the bot API key
and Zulip stream with the appropriate information.
`{{ external_api_uri_subdomain }}/v1/external/appfollow?api_key=test_api_key&stream=appfollow`
3. **Save changes** – all done!
New reviews for your app will be delivered to your Zulip stream.
![](/static/images/integrations/appfollow/002.png)