mirror of https://github.com/zulip/zulip.git
integration-docs: Clarify use of event-filtering-additional-feature.
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:
parent
682a214d65
commit
7e7e6b7ba9
|
@ -118,6 +118,13 @@ Here are a few common macros used to document Zulip's integrations:
|
||||||
For an example rendering, see the end of
|
For an example rendering, see the end of
|
||||||
[the docs for Zulip's GitHub integration][github-integration].
|
[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
|
- `{!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
|
||||||
API bindings. This macro is usually used in non-webhook integration docs under
|
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
|
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).
|
||||||
|
|
||||||
- `{!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
|
[github-integration]: https://zulip.com/integrations/doc/github
|
||||||
[zendesk]: https://zulip.com/integrations/doc/zendesk
|
[zendesk]: https://zulip.com/integrations/doc/zendesk
|
||||||
[matrix]: https://zulip.com/integrations/doc/matrix#configure-the-bridge
|
[matrix]: https://zulip.com/integrations/doc/matrix#configure-the-bridge
|
||||||
[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
|
||||||
[front]: https://zulip.com/integrations/doc/front
|
[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
|
[integrations-file]: https://github.com/zulip/zulip/blob/main/zerver/lib/integrations.py
|
||||||
|
|
||||||
## Writing guidelines
|
## Writing guidelines
|
||||||
|
|
|
@ -28,12 +28,8 @@ Get Azure DevOps notifications in Zulip!
|
||||||
|
|
||||||
![](/static/images/integrations/azuredevops/001.png)
|
![](/static/images/integrations/azuredevops/001.png)
|
||||||
|
|
||||||
{% if all_event_types is defined %}
|
|
||||||
|
|
||||||
{!event-filtering-additional-feature.md!}
|
{!event-filtering-additional-feature.md!}
|
||||||
|
|
||||||
{% endif %}
|
|
||||||
|
|
||||||
### Configuration options
|
### Configuration options
|
||||||
|
|
||||||
{!git-branches-additional-feature.md!}
|
{!git-branches-additional-feature.md!}
|
||||||
|
|
|
@ -25,12 +25,8 @@ Receive notifications about Basecamp events in Zulip!
|
||||||
|
|
||||||
![](/static/images/integrations/basecamp/001.png)
|
![](/static/images/integrations/basecamp/001.png)
|
||||||
|
|
||||||
{% if all_event_types is defined %}
|
|
||||||
|
|
||||||
{!event-filtering-additional-feature.md!}
|
{!event-filtering-additional-feature.md!}
|
||||||
|
|
||||||
{% endif %}
|
|
||||||
|
|
||||||
### Related documentation
|
### Related documentation
|
||||||
|
|
||||||
{!webhooks-url-specification.md!}
|
{!webhooks-url-specification.md!}
|
||||||
|
|
|
@ -30,12 +30,8 @@ Bitbucket Server click [here](./bitbucket3).
|
||||||
|
|
||||||
![](/static/images/integrations/bitbucket/003.png)
|
![](/static/images/integrations/bitbucket/003.png)
|
||||||
|
|
||||||
{% if all_event_types is defined %}
|
|
||||||
|
|
||||||
{!event-filtering-additional-feature.md!}
|
{!event-filtering-additional-feature.md!}
|
||||||
|
|
||||||
{% endif %}
|
|
||||||
|
|
||||||
### Configuration options
|
### Configuration options
|
||||||
|
|
||||||
{!git-branches-additional-feature.md!}
|
{!git-branches-additional-feature.md!}
|
||||||
|
|
|
@ -30,12 +30,8 @@ Bitbucket Cloud (SAAS service) click [here](./bitbucket2).
|
||||||
|
|
||||||
![](/static/images/integrations/bitbucket/004.png)
|
![](/static/images/integrations/bitbucket/004.png)
|
||||||
|
|
||||||
{% if all_event_types is defined %}
|
|
||||||
|
|
||||||
{!event-filtering-additional-feature.md!}
|
{!event-filtering-additional-feature.md!}
|
||||||
|
|
||||||
{% endif %}
|
|
||||||
|
|
||||||
### Configuration options
|
### Configuration options
|
||||||
|
|
||||||
{!git-branches-additional-feature.md!}
|
{!git-branches-additional-feature.md!}
|
||||||
|
|
|
@ -27,12 +27,8 @@ CircleCI with GitHub, BitBucket and GitLab.
|
||||||
![](/static/images/integrations/circleci/001.png)
|
![](/static/images/integrations/circleci/001.png)
|
||||||
![](/static/images/integrations/circleci/002.png)
|
![](/static/images/integrations/circleci/002.png)
|
||||||
|
|
||||||
{% if all_event_types is defined %}
|
|
||||||
|
|
||||||
{!event-filtering-additional-feature.md!}
|
{!event-filtering-additional-feature.md!}
|
||||||
|
|
||||||
{% endif %}
|
|
||||||
|
|
||||||
### Related documentation
|
### Related documentation
|
||||||
|
|
||||||
{!webhooks-url-specification.md!}
|
{!webhooks-url-specification.md!}
|
||||||
|
|
|
@ -23,12 +23,8 @@ Get Zulip notifications for your Clubhouse Stories and Epics!
|
||||||
|
|
||||||
![](/static/images/integrations/clubhouse/001.png)
|
![](/static/images/integrations/clubhouse/001.png)
|
||||||
|
|
||||||
{% if all_event_types is defined %}
|
|
||||||
|
|
||||||
{!event-filtering-additional-feature.md!}
|
{!event-filtering-additional-feature.md!}
|
||||||
|
|
||||||
{% endif %}
|
|
||||||
|
|
||||||
### Related documentation
|
### Related documentation
|
||||||
|
|
||||||
{!webhooks-url-specification.md!}
|
{!webhooks-url-specification.md!}
|
||||||
|
|
|
@ -23,12 +23,8 @@ Receive Freshping notifications in Zulip!
|
||||||
|
|
||||||
![](/static/images/integrations/freshping/001.png)
|
![](/static/images/integrations/freshping/001.png)
|
||||||
|
|
||||||
{% if all_event_types is defined %}
|
|
||||||
|
|
||||||
{!event-filtering-additional-feature.md!}
|
{!event-filtering-additional-feature.md!}
|
||||||
|
|
||||||
{% endif %}
|
|
||||||
|
|
||||||
### Related documentation
|
### Related documentation
|
||||||
|
|
||||||
{!webhooks-url-specification.md!}
|
{!webhooks-url-specification.md!}
|
||||||
|
|
|
@ -86,12 +86,8 @@ Receive Freshstatus notifications in Zulip!
|
||||||
|
|
||||||
![](/static/images/integrations/freshstatus/001.png)
|
![](/static/images/integrations/freshstatus/001.png)
|
||||||
|
|
||||||
{% if all_event_types is defined %}
|
|
||||||
|
|
||||||
{!event-filtering-additional-feature.md!}
|
{!event-filtering-additional-feature.md!}
|
||||||
|
|
||||||
{% endif %}
|
|
||||||
|
|
||||||
### Related documentation
|
### Related documentation
|
||||||
|
|
||||||
{!webhooks-url-specification.md!}
|
{!webhooks-url-specification.md!}
|
||||||
|
|
|
@ -32,12 +32,8 @@ to receive Front notifications without leaving Zulip!
|
||||||
|
|
||||||
![](/static/images/integrations/front/001.png)
|
![](/static/images/integrations/front/001.png)
|
||||||
|
|
||||||
{% if all_event_types is defined %}
|
|
||||||
|
|
||||||
{!event-filtering-additional-feature.md!}
|
{!event-filtering-additional-feature.md!}
|
||||||
|
|
||||||
{% endif %}
|
|
||||||
|
|
||||||
### Related documentation
|
### Related documentation
|
||||||
|
|
||||||
{!webhooks-url-specification.md!}
|
{!webhooks-url-specification.md!}
|
||||||
|
|
|
@ -32,12 +32,8 @@ Receive GitLab notifications in Zulip!
|
||||||
|
|
||||||
![](/static/images/integrations/gitlab/001.png)
|
![](/static/images/integrations/gitlab/001.png)
|
||||||
|
|
||||||
{% if all_event_types is defined %}
|
|
||||||
|
|
||||||
{!event-filtering-additional-feature.md!}
|
{!event-filtering-additional-feature.md!}
|
||||||
|
|
||||||
{% endif %}
|
|
||||||
|
|
||||||
### Configuration options
|
### Configuration options
|
||||||
|
|
||||||
* By default, the Zulip topics for merge requests will contain the title
|
* By default, the Zulip topics for merge requests will contain the title
|
||||||
|
|
|
@ -68,12 +68,8 @@ See your Grafana dashboard alerts in Zulip!
|
||||||
|
|
||||||
![](/static/images/integrations/grafana/001.png)
|
![](/static/images/integrations/grafana/001.png)
|
||||||
|
|
||||||
{% if all_event_types is defined %}
|
|
||||||
|
|
||||||
{!event-filtering-additional-feature.md!}
|
{!event-filtering-additional-feature.md!}
|
||||||
|
|
||||||
{% endif %}
|
|
||||||
|
|
||||||
### Related documentation
|
### Related documentation
|
||||||
|
|
||||||
{!webhooks-url-specification.md!}
|
{!webhooks-url-specification.md!}
|
||||||
|
|
Loading…
Reference in New Issue