paulmataruso/zulip
1
0
Fork 0
mirror of https://github.com/zulip/zulip.git synced 2025-11-03 05:23:35 +00:00
Code Issues Packages Projects Releases Wiki Activity

integration-docs: Clarify use of event-filtering-additional-feature.

Browse Source 
Using an if block when {!event-filtering-additional-feature.md!}
is used implied that we plan to have this in all webhook doc .md
files.

But, it actually makes sense to only use this macro when the
webhook integration actually supports event filtering.
This commit is contained in:
Lauryn Menard
2024-07-08 14:03:25 +02:00
committed by Tim Abbott
parent 682a214d65
commit 7e7e6b7ba9
12 changed files with 8 additions and 49 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
docs/documentation/integrations.md
View File

@@ -118,6 +118,13 @@ Here are a few common macros used to document Zulip's integrations:
For an example rendering, see the end of
[the docs for Zulip's GitHub integration][github-integration].
- `{!event-filtering-additional-feature.md!}` macro - If a webhook integration
supports event filtering, then this adds a section with the specific
events that can be filtered for the integration. Should be included in
the documentation if `all_event_types` is set in the webhook integration
view. For an example see, the **Filtering incoming events** section in
[Zulip's GitLab integration][gitlab].
- `{!download-python-bindings.md!}` macro - Links to Zulip's
[API page](https://zulip.com/api/) to download and install Zulip's
API bindings. This macro is usually used in non-webhook integration docs under
@@ -151,17 +158,13 @@ Here are a few common macros used to document Zulip's integrations:
For an example rendering, see
[Zulip's Beanstalk integration](https://zulip.com/integrations/doc/beanstalk).
- `{!event-filtering-instructions}` macro - Instructs user to use the event
filtering feature and shows a list of event types that the integration supports.
For an example rendering, see the last 4 paragraphs of **Step 2** in
[the docs for Zulip's Front integration][front].
[github-integration]: https://zulip.com/integrations/doc/github
[zendesk]: https://zulip.com/integrations/doc/zendesk
[matrix]: https://zulip.com/integrations/doc/matrix#configure-the-bridge
[codebase]: https://zulip.com/integrations/doc/codebase
[beanstalk]: https://zulip.com/integrations/doc/beanstalk
[front]: https://zulip.com/integrations/doc/front
[gitlab]: https://zulip.com/integrations/doc/gitlab
[integrations-file]: https://github.com/zulip/zulip/blob/main/zerver/lib/integrations.py
## Writing guidelines