From e9e2721aa2bbc21881229b80298a69378dfbeb78 Mon Sep 17 00:00:00 2001 From: Rishi Gupta Date: Mon, 20 Aug 2018 20:31:27 -0700 Subject: [PATCH] integration docs: Simplify create a bot instructions. --- templates/zerver/help/include/create-a-bot-indented.md | 7 +------ templates/zerver/help/include/create-a-bot.md | 7 +------ templates/zerver/help/include/create-stream.md | 5 +---- templates/zerver/help/include/webhook-url.md | 2 +- 4 files changed, 4 insertions(+), 17 deletions(-) diff --git a/templates/zerver/help/include/create-a-bot-indented.md b/templates/zerver/help/include/create-a-bot-indented.md index 3c97e39317..19cdae44b3 100644 --- a/templates/zerver/help/include/create-a-bot-indented.md +++ b/templates/zerver/help/include/create-a-bot-indented.md @@ -1,12 +1,7 @@ - On your {{ settings_html|safe }}, - [create a bot](/help/add-a-bot-or-integration) for + [Create a bot](/help/add-a-bot-or-integration) for {{ integration_display_name }}. Make sure that you select **Incoming webhook** as the **Bot type**: ![](/static/images/help/bot_types.png) - The API key for an incoming webhook bot cannot be used to read messages out - of Zulip. Thus, using an incoming webhook bot lowers the security risk of - exposing the bot's API key to a third-party service. - Fill out the rest of the fields, and click **Create bot**. diff --git a/templates/zerver/help/include/create-a-bot.md b/templates/zerver/help/include/create-a-bot.md index 995e9359c1..3687c6d2b5 100644 --- a/templates/zerver/help/include/create-a-bot.md +++ b/templates/zerver/help/include/create-a-bot.md @@ -1,12 +1,7 @@ -On your {{ settings_html|safe }}, -[create a bot](/help/add-a-bot-or-integration) for +[Create a bot](/help/add-a-bot-or-integration) for {{ integration_display_name }}. Make sure that you select **Incoming webhook** as the **Bot type**: ![](/static/images/help/bot_types.png) -The API key for an incoming webhook bot cannot be used to read messages out -of Zulip. Thus, using an incoming webhook bot lowers the security risk of -exposing the bot's API key to a third-party service. - Fill out the rest of the fields, and click **Create bot**. diff --git a/templates/zerver/help/include/create-stream.md b/templates/zerver/help/include/create-stream.md index 5fbec189cf..f0f1c3d323 100644 --- a/templates/zerver/help/include/create-stream.md +++ b/templates/zerver/help/include/create-stream.md @@ -1,5 +1,2 @@ Create the stream you'd like to use for -{{ integration_display_name }} notifications, and subscribe all -interested parties to this stream. We recommend the -name `{{ recommended_stream_name }}`. You still need to create -the stream even if you are using this default recommendation. +{{ integration_display_name }} notifications. diff --git a/templates/zerver/help/include/webhook-url.md b/templates/zerver/help/include/webhook-url.md index 2619c49a0b..a5a75fe32a 100644 --- a/templates/zerver/help/include/webhook-url.md +++ b/templates/zerver/help/include/webhook-url.md @@ -1 +1 @@ -`{{ api_url }}{{ integration_url }}?api_key=abcdefgh&stream={{ recommended_stream_name }}` +`{{ api_url }}{{ integration_url }}?api_key=abcdefgh&stream=stream_name`