tools: Update docs for create-api-changelog tool.

This commit is contained in:
Vector73
2025-05-21 13:36:33 +00:00
committed by Tim Abbott
parent 98b90a8da1
commit c5c1b79580
2 changed files with 19 additions and 7 deletions

View File

@@ -334,14 +334,23 @@ above.
post an example of the output in the pull request.
1. Run `./tools/create-api-changelog` which will create a new empty
changelog file in `api_docs/unmerged.d/` directory. Open this
file and document the API changes. The content of this file will be
merged into `api_docs/changelog.md` when your commit is merged into the
`main` branch.
markdown file in `api_docs/unmerged.d/` directory
(e.g., `api_docs/unmerged.d/ZF-1f4a39.md`). Open this
file and document the API changes, formatted as an unordered list
(`*` bullets). The raw content of this file will be merged into
`api_docs/changelog.md` when your commit is merged into the `main`
branch. Therefore, keep the formatting and line wrapping consistent
with the content in `api_docs/changelog.md`.
1. Add a `**Changes**` entry in the description of the new API/event in
`zerver/openapi/zulip.yaml`, and mention the name of the file generated
in the previous step in place of the API feature level.
1. Add a `**Changes**` note in the description of all updates and
additions to the API documentation (`zerver/openapi/zulip.yaml`),
and mention the name of the file generated in the previous step
(without the `.md` extension) in place of the API feature level,
for example:
```yaml
**Changes**: New in Zulip 11.0 (feature level ZF-1f4a39).
```
## Why a custom system?

View File

@@ -28,5 +28,8 @@ if __name__ == "__main__":
f"""Created an empty API changelog file.
If you've made changes to the API, document them here:
{file_path}
For help, see:
https://zulip.readthedocs.io/en/latest/documentation/api.html#step-by-step-guide
"""
)