paulmataruso/zulip
1
0
Fork 0
mirror of https://github.com/zulip/zulip.git synced 2025-11-01 12:33:40 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: Reference the new templates directory for PythonAPIIntegrations.

Browse Source 
Mention the new templates directory `static/generated/integrations`, and
the script that generates them, in the doc on documenting integrations.
This commit is contained in:
Niloth P
2025-03-26 10:16:47 +05:30
committed by Tim Abbott
parent b2910aa05c
commit 610f8b42c3
1 changed files with 12 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
docs/documentation/integrations.md
View File

@@ -8,7 +8,18 @@ integrations involves writing Markdown files, either at
`templates/zerver/integrations/{integration_name}.md` (for other
integrations).
Usually, this involves a few steps:
The [integrations][api-integrations] in
[zulip/python-zulip-api][api-repo] have their corresponding Markdown files
at `zulip/integrations/{integration_name}/doc.md`, which are imported into
[zulip/zulip][zulip-repo] at
`static/generated/integrations/{integration_name}/doc.md` using the
`tools/setup/generate_bots_integrations_static_files.py` script.
[api-repo]: https://github.com/zulip/python-zulip-api/
[api-integrations]: https://github.com/zulip/python-zulip-api/tree/main/zulip/integrations
[zulip-repo]: https://github.com/zulip/zulip
Typically, the documentation process involves the following steps:
- Add text explaining all of the steps required to set up the
integration, including what URLs to use, etc. See