diff --git a/tools/lint b/tools/lint index 28afc50ea7..a69f61e1f3 100755 --- a/tools/lint +++ b/tools/lint @@ -583,6 +583,7 @@ def build_custom_checkers(by_lang): "docs/readme-symlink.md", "README.md", "zerver/webhooks/airbrake/doc.md", + "zerver/webhooks/appfollow/doc.md", "zerver/webhooks/trello/doc.md", } for fn in by_lang['md']: diff --git a/zerver/webhooks/appfollow/doc.html b/zerver/webhooks/appfollow/doc.html deleted file mode 100644 index 829a7f6937..0000000000 --- a/zerver/webhooks/appfollow/doc.html +++ /dev/null @@ -1,40 +0,0 @@ -

- 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, and:

- -
    -
  1. -

    - Click on the app for which you'd like to receive reviews. - Click on Integrations and then go to the Others tab. -

    - - -
  2. -
  3. -

    - 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

    -
  4. -
- -

- Save changes – all done!
- New reviews for your app will be delivered to your Zulip stream. -

- - diff --git a/zerver/webhooks/appfollow/doc.md b/zerver/webhooks/appfollow/doc.md new file mode 100644 index 0000000000..5ad375f515 --- /dev/null +++ b/zerver/webhooks/appfollow/doc.md @@ -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)