mirror of
https://github.com/zulip/zulip.git
synced 2025-11-02 13:03:29 +00:00
integration-docs: Remove unused macros.
The `append-channel-name` and `append-topic` macros' instructions are unnecessary as the topic and channel names are now part of the generated URL. The `git-webhook-url-branches` macro becomes equivalent to `git-append-branches` with the auto-generation of the URL.
This commit is contained in:
@@ -100,16 +100,6 @@ Here are a few common macros used to document Zulip's integrations:
|
||||
that your integration documentation will provide the correct URL for whatever
|
||||
server it is deployed on.
|
||||
|
||||
- `{!append-channel-name.md!}` macro - Recommends appending `&stream=channel_name`
|
||||
to a URL in cases where supplying a channel name in the URL is optional.
|
||||
Supplying a channel name is optional for most Zulip integrations. If you use
|
||||
`{!generate-integration-url.md!}`, this macro need not be used.
|
||||
|
||||
- `{!append-topic.md!}` macro - Recommends appending `&topic=my_topic` to a URL
|
||||
to supply a custom topic for webhook notification messages. Supplying a custom
|
||||
topic is optional for most Zulip integrations. If you use
|
||||
`{!generate-integration-url.md!}`, this macro need not be used.
|
||||
|
||||
- `{!congrats.md!}` macro - Inserts congratulatory lines signifying the
|
||||
successful setup of a given integration. This macro is usually used at
|
||||
the end of the documentation, right before the sample message screenshot.
|
||||
@@ -137,11 +127,10 @@ Here are a few common macros used to document Zulip's integrations:
|
||||
rendering, see **Step 4** of
|
||||
[the docs for Zulip's Codebase integration][codebase].
|
||||
|
||||
- `{!git-append-branches.md!}` and `{!git-webhook-url-with-branches.md!}` -
|
||||
These two macros explain how to specify a list of branches in the webhook URL
|
||||
to filter notifications in our Git-related webhooks. For an example rendering,
|
||||
see the last paragraph of **Step 2** in
|
||||
[the docs for Zulip's GitHub integration][github-integration].
|
||||
- `{!git-append-branches.md!}` - This macro explains how to specify a list
|
||||
of branches in the webhook URL to filter notifications in our Git-related
|
||||
webhooks. For an example rendering, see the last paragraph of **Step 2**
|
||||
in [the docs for Zulip's GitHub integration][github-integration].
|
||||
|
||||
- `{!webhook-url.md!}` - Used internally by `{!generate-integration-url.md!}`
|
||||
to generate the webhook URL.
|
||||
|
||||
@@ -1,4 +0,0 @@
|
||||
* To specify a Zulip channel for these notifications, you must explicitly
|
||||
append `&stream=channel_name` to the end of the webhook URL constructed
|
||||
above, where `channel_name` is the channel you want the notifications
|
||||
sent to.
|
||||
@@ -1,2 +0,0 @@
|
||||
To change the topic used by the bot, simply append `&topic=name`
|
||||
to the end of the above URL, where `name` is your topic.
|
||||
@@ -1,5 +0,0 @@
|
||||
You can also limit the branches you receive notifications for by
|
||||
specifying them in a comma-separated list at the end of the URL,
|
||||
like so:
|
||||
|
||||
`{{ api_url }}{{ integration_url }}?api_key=abcdefgh&stream={{ recommended_channel_name }}&branches=main,development`
|
||||
Reference in New Issue
Block a user