From 1abae8baaa94f8fe437bd129ddbb714a78a19cad Mon Sep 17 00:00:00 2001 From: akshatdalton Date: Tue, 20 Oct 2020 23:05:09 +0000 Subject: [PATCH] docs: Update guidelines to URL-encode stream name or topic name. Updated create-bot-construct-url-indented.md file with guidelines on how to URL-encode stream name and topic name. The hyperlink added will solve the issue for those who use emoji in stream name or topic name. Tweaked by tabbott to edit the copy and update the non-indented version as well. Fixes #16430. --- .../help/include/create-bot-construct-url-indented.md | 11 ++++++----- .../zerver/help/include/create-bot-construct-url.md | 11 ++++++----- 2 files changed, 12 insertions(+), 10 deletions(-) diff --git a/templates/zerver/help/include/create-bot-construct-url-indented.md b/templates/zerver/help/include/create-bot-construct-url-indented.md index 33047e9030..9d7a76adf8 100644 --- a/templates/zerver/help/include/create-bot-construct-url-indented.md +++ b/templates/zerver/help/include/create-bot-construct-url-indented.md @@ -6,9 +6,10 @@ {!webhook-url.md!} Modify the parameters of the URL above, where `api_key` is the API key - of your Zulip bot, and `stream` is the URL-encoded stream name you want the - notifications sent to. If you do not specify a `stream`, the bot will - send notifications via PMs to the creator of the bot. + of your Zulip bot, and `stream` is the [URL-encoded](https://www.urlencoder.org/) + stream name you want the notifications sent to. If you do not specify a + `stream`, the bot will send notifications via PMs to the creator of the bot. - If you'd like this integration to always send to the topic - `your topic`, just add `&topic=your%20topic` to the end of the URL. + If you'd like this integration to always send to a specific topic, + just include the (URL-encoded) topic as an additional parameter + (E.g. for `your topic`, append `&topic=your%20topic` to the URL). diff --git a/templates/zerver/help/include/create-bot-construct-url.md b/templates/zerver/help/include/create-bot-construct-url.md index b56b45dfd2..b10671968c 100644 --- a/templates/zerver/help/include/create-bot-construct-url.md +++ b/templates/zerver/help/include/create-bot-construct-url.md @@ -6,9 +6,10 @@ bot using the bot's API key and the desired stream name: {!webhook-url.md!} Modify the parameters of the URL above, where `api_key` is the API key -of your Zulip bot, and `stream` is the URL-encoded stream name you want the -notifications sent to. If you do not specify a `stream`, the bot will -send notifications via PMs to the creator of the bot. +of your Zulip bot, and `stream` is the [URL-encoded](https://www.urlencoder.org/) +stream name you want the notifications sent to. If you do not specify a +`stream`, the bot will send notifications via PMs to the creator of the bot. -If you'd like this integration to always send to the topic -`your topic`, just add `&topic=your%20topic` to the end of the URL. +If you'd like this integration to always send to a specific topic, +just include the (URL-encoded) topic as an additional parameter +(E.g. for `your topic`, append `&topic=your%20topic` to the URL).