From 0cfe0891521f47d0e05519741b8d7aa0d482c5ac Mon Sep 17 00:00:00 2001 From: Eeshan Garg Date: Sun, 4 Jun 2017 21:23:04 -0230 Subject: [PATCH] webhooks/github: Migrate docs to Markdown. --- zerver/webhooks/github/doc.html | 53 --------------------------------- zerver/webhooks/github/doc.md | 44 +++++++++++++++++++++++++++ 2 files changed, 44 insertions(+), 53 deletions(-) delete mode 100644 zerver/webhooks/github/doc.html create mode 100644 zerver/webhooks/github/doc.md diff --git a/zerver/webhooks/github/doc.html b/zerver/webhooks/github/doc.html deleted file mode 100644 index aea5fef7c6..0000000000 --- a/zerver/webhooks/github/doc.html +++ /dev/null @@ -1,53 +0,0 @@ -

- This webhook bases on deprecated concept that is - GitHub Services -

- -

- First, create the stream you'd like to use for GitHub notifications, - and subscribe all interested parties to this stream. The integration will - use the default stream commits if no stream is supplied in - the hook; you still need to create the stream even if you are using this - default. -

- -

Next, go to your repository page and click "Settings":

-

- -

From there, select "Webhooks & Services":

-

- -

To find the Zulip hook, you have to click on Configure services.

-

- -

- Select "Zulip" from the list of service hooks. Fill in - the API key and email address for your bot and check - the "active" checkbox. Specify - {{ external_api_uri_subdomain }}/v1/external/github as the "Alternative - endpoint". You can optionally supply the Zulip stream (the - default is commits) and restrict Zulip - notifications to a specified set of branches. -

- -

- Further configuration is possible. By default, commits traffic (pushes, commit comments), - GitHub issues traffic, and pull requests are enabled. You can exclude certain types of traffic - via the checkboxes. If you want commit traffic, issue traffic, and pull requests to go to - different places, you can use the Commit Stream and Issue Stream overrides; - otherwise, it is safe to leave these fields blank and just have it default to the Stream - setting. -

- -

- Click the "Update settings" button to complete the - configuration: -

-

- -

- Congratulations! You're done!
When team members push to - your repository, you'll get a Zulip notification that looks like this: -

- -

diff --git a/zerver/webhooks/github/doc.md b/zerver/webhooks/github/doc.md new file mode 100644 index 0000000000..f328fb8839 --- /dev/null +++ b/zerver/webhooks/github/doc.md @@ -0,0 +1,44 @@ +This webhook is based on the deprecated +[GitHub Services](https://github.com/github/github-services). + +{!create-stream.md!} + +However, the integration will use the default stream `commits` +if no stream is supplied in the hook; you still need to create +the stream even if you are using this default. + +Next, go to your repository page and click **Settings**: + +![](/static/images/integrations/github/001.png) + +From there, select **Webhooks & Services**: + +![](/static/images/integrations/github/002.png) + +To find the Zulip hook, you have to click on **Configure services**. + +![](/static/images/integrations/github/003.png) + +Select **Zulip** from the list of service hooks. Fill in the API key +and email address for your bot that you created earlier and check +the **"active"** checkbox. Specify +`{{ external_api_uri_subdomain }}/v1/external/github` as the +**Alternative endpoint**. You can optionally supply the Zulip stream +(the default is `commits`) and restrict Zulip notifications to a +specified set of branches. + +Further configuration is possible. By default, commits traffic +(pushes, commit comments), GitHub issues traffic, and pull requests +are enabled. You can exclude certain types of traffic via the checkboxes. +If you want commit traffic, issue traffic, and pull requests to go to +different places, you can use the **Commit Stream** and **Issue Stream** +overrides; otherwise, it is safe to leave these fields blank and just +have it default to the **Stream** setting. + +Click the **Update settings** button to complete the configuration: + +![](/static/images/integrations/github/004.png) + +{!congrats.md!} + +![](/static/images/integrations/github/005.png)