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

integrations: Add documentation for the event filtering system.

Browse Source 
We create "event-filter-instruction.md" and add it to
"create-bot-construct-url.md". This allows the user to keep track of the
supported event types for most of the integrations that implement this
feature. Note that not all integrations use "create-bot-construct-url.md".

We also need to rename "function" to "view_function" to make this change
type-check.

This is relevant to #18392.

Signed-off-by: Zixuan James Li <p359101898@gmail.com>
This commit is contained in:
Zixuan James Li
2022-08-16 15:27:45 -04:00
committed by Tim Abbott
parent 0cd76d17d7
commit 6b527dfa61
5 changed files with 33 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
docs/documentation/integrations.md
View File

@@ -140,9 +140,15 @@ 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
[codebase]: https://zulip.com/integrations/doc/codebase
[beanstalk]: https://zulip.com/integrations/doc/beanstalk
[front]: https://zulip.com/integrations/doc/front
[integrations-file]: https://github.com/zulip/zulip/blob/main/zerver/lib/integrations.py
## Writing guidelines