paulmataruso/zulip
1
0
Fork 0
mirror of https://github.com/zulip/zulip.git synced 2025-10-23 04:52:12 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: Avoid [GitHub] as an internal Markdown link reference name.

Browse Source 
To avoid confusing the linter later when Prettier lowercases these.

Signed-off-by: Anders Kaseorg <anders@zulip.com>
This commit is contained in:
Anders Kaseorg
2021-08-20 15:03:43 -07:00
committed by Tim Abbott
parent 0e4a30daad
commit fdb7ec8c9e
1 changed files with 5 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
docs/documentation/integrations.md
View File

@@ -74,7 +74,7 @@ Here are a few common macros used to document Zulip's integrations:
* `{!create-stream.md!}` macro - Recommends that users create a dedicated * `{!create-stream.md!}` macro - Recommends that users create a dedicated
stream for a given integration. Usually the first step is setting up an stream for a given integration. Usually the first step is setting up an
integration or incoming webhook. For an example rendering, see **Step 1** of integration or incoming webhook. For an example rendering, see **Step 1** of
[the docs for Zulip's GitHub integration][GitHub]. [the docs for Zulip's GitHub integration][github-integration].
* `{!create-bot-construct-url-indented.md!}` macro - Instructs users to create a bot * `{!create-bot-construct-url-indented.md!}` macro - Instructs users to create a bot
for a given integration and construct a webhook URL using the bot API key for a given integration and construct a webhook URL using the bot API key
@@ -82,7 +82,7 @@ Here are a few common macros used to document Zulip's integrations:
by using attributes in the `WebhookIntegration` class in by using attributes in the `WebhookIntegration` class in
[zerver/lib/integrations.py][integrations-file]. [zerver/lib/integrations.py][integrations-file].
This macro is usually used right after `{!create-stream!}`. For an example This macro is usually used right after `{!create-stream!}`. For an example
rendering, see **Step 2** of [the docs for Zulip's GitHub integration][GitHub]. 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
@@ -105,7 +105,7 @@ Here are a few common macros used to document Zulip's integrations:
successful setup of a given integration. This macro is usually used at successful setup of a given integration. This macro is usually used at
the end of the documentation, right before the sample message screenshot. the end of the documentation, right before the sample message screenshot.
For an example rendering, see the end of For an example rendering, see the end of
[the docs for Zulip's GitHub integration][GitHub]. [the docs for Zulip's GitHub integration][github-integration].
* `{!download-python-bindings.md!}` macro - Links to Zulip's * `{!download-python-bindings.md!}` macro - Links to Zulip's
[API page](https://zulip.com/api/) to download and install Zulip's [API page](https://zulip.com/api/) to download and install Zulip's
@@ -125,7 +125,7 @@ Here are a few common macros used to document Zulip's integrations:
These two macros explain how to specify a list of branches in the webhook URL 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, to filter notifications in our Git-related webhooks. For an example rendering,
see the last paragraph of **Step 2** in see the last paragraph of **Step 2** in
[the docs for Zulip's GitHub integration][GitHub]. [the docs for Zulip's GitHub integration][github-integration].
* `{!webhook-url.md!}` - Used internally by `{!create-bot-construct-url-indented.md!}` * `{!webhook-url.md!}` - Used internally by `{!create-bot-construct-url-indented.md!}`
to generate the webhook URL. to generate the webhook URL.
@@ -143,7 +143,7 @@ Here are a few common macros used to document Zulip's integrations:
For an example rendering, see For an example rendering, see
[Zulip's Beanstalk integration](https://zulip.com/integrations/doc/beanstalk). [Zulip's Beanstalk integration](https://zulip.com/integrations/doc/beanstalk).
[GitHub]: https://zulip.com/integrations/doc/github [github-integration]: https://zulip.com/integrations/doc/github
[codebase]: https://zulip.com/integrations/doc/codebase [codebase]: https://zulip.com/integrations/doc/codebase
[beanstalk]: https://zulip.com/integrations/doc/beanstalk [beanstalk]: https://zulip.com/integrations/doc/beanstalk
[integrations-file]: https://github.com/zulip/zulip/blob/master/zerver/lib/integrations.py [integrations-file]: https://github.com/zulip/zulip/blob/master/zerver/lib/integrations.py