From 2d25b6581eb011aabac52a200c2c242820bcfa6c Mon Sep 17 00:00:00 2001 From: Eeshan Garg Date: Wed, 24 May 2017 23:48:51 -0230 Subject: [PATCH] webhooks/greenhouse: Migrate docs to Markdown. --- zerver/webhooks/greenhouse/doc.html | 32 ----------------------------- zerver/webhooks/greenhouse/doc.md | 19 +++++++++++++++++ 2 files changed, 19 insertions(+), 32 deletions(-) delete mode 100644 zerver/webhooks/greenhouse/doc.html create mode 100644 zerver/webhooks/greenhouse/doc.md diff --git a/zerver/webhooks/greenhouse/doc.html b/zerver/webhooks/greenhouse/doc.html deleted file mode 100644 index 8735ba1137..0000000000 --- a/zerver/webhooks/greenhouse/doc.html +++ /dev/null @@ -1,32 +0,0 @@ -

- First, create a stream where you would like to receive Greenhouse - notifications and subscribe all interested parties to the - stream. The integration will automatically use the default - stream greenhouse if no stream is supplied, though you - will still need to create the stream manually even though it's the - default. -

- -

- Next, go to the Zulip settings page and create a bot named - Greenhouse. Go to the account settings page of your Greenhouse - account and under Webhooks, add the below URL and name the - integration, Zulip. -

- -

{{ external_api_uri_subdomain }}/v1/external/greenhouse?api_key=abcdefgh&stream=greenhouse

- -

- Note: api_key must be reconfigured to be the API key of your Zulip bot.
- If you want to change the stream that receives notifications, change stream= in the URL.
- To change the topic displayed by the bot, simply append &topic=name to the end of the above URL. - Where name is your topic. -

- -

- Congratulations! You're all set
- Your messages should look like this: -

- -

- diff --git a/zerver/webhooks/greenhouse/doc.md b/zerver/webhooks/greenhouse/doc.md new file mode 100644 index 0000000000..37a48fbba4 --- /dev/null +++ b/zerver/webhooks/greenhouse/doc.md @@ -0,0 +1,19 @@ +{!create-stream.md!} + +The integration will automatically use the default stream +`greenhouse` if no stream is supplied, though you will still +need to create the stream manually even though it's the +default. + +{!create-bot-construct-url.md!} + +Go to the account settings page of your Greenhouse account and +under **Webhooks**, add the above URL and name the integration, +Zulip. + +To change the topic displayed by the bot, simply append `&topic=name` +to the end of the above URL, where `name` is your topic. + +{!congrats.md!} + +![](/static/images/integrations/greenhouse/000.png)