Mirror
/
zulip
mirror of https://github.com/zulip/zulip.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

docs: Remove out of date or redudant macro information. 

The `SITE` variable mentioned in the removed text seems to no
longer be part of the integrations system.

Removed the second bullet point documenting the macro to create
an incoming webhook instruction.
This commit is contained in:
Lauryn Menard 2024-11-19 15:38:15 +01:00 committed by Tim Abbott
parent 9d1ca5476a
commit 22e3c80329
1 changed files with 1 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
docs/documentation/integrations.md
View File

@ -85,17 +85,11 @@ Here are a few common macros used to document Zulip's integrations:
for a given integration and select **Generic bot** as the **Bot type**. For an for a given integration and select **Generic bot** as the **Bot type**. For an
example rendering, see [the docs for Zulip's Matrix integration][matrix]. example rendering, see [the docs for Zulip's Matrix integration][matrix].
- `{!create-an-incoming-webhook.md!}` macro - Instructs users to create a bot
for a given integration and select **Incoming webhook** as the **Bot type**.
This macro is usually used right after `{!create-channel.md!}`. For an example
rendering, see **Step 2** of [the docs for Zulip's GitHub integration][github-integration].
**Note:** If special configuration is **Note:** If special configuration is
required to set up the URL and you can't use this macro, be sure to use the required to set up the URL and you can't use this macro, be sure to use the
`{{ api_url }}` template variable, so that your integration `{{ api_url }}` template variable, so that your integration
documentation will provide the correct URL for whatever server it is documentation will provide the correct URL for whatever server it is
deployed on. If special configuration is required to set the `SITE` deployed on.
variable, you should document that too.
- `{!generate-integration-url.md!}` - Instructs user how to get the URL for a - `{!generate-integration-url.md!}` - Instructs user how to get the URL for a
bot for a given integration. An example URL is generated automatically for bot for a given integration. An example URL is generated automatically for