Skip to content

Commit 5f92d05

Browse files
authored
Add api docs section for release process. (#365)
1 parent f98e153 commit 5f92d05

1 file changed

Lines changed: 9 additions & 1 deletion

File tree

docs/release-process.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -253,7 +253,15 @@ If there are any new contributors for this release, please add a `New Contributo
253253

254254
Once the PR has been approved, add release notes to the Github release page (https://github.com/apache/pulsar-client-node/releases)
255255

256-
#### 10. Announce the release
256+
#### 10. Add api docs
257+
Create a PR to add api docs to the pulsar site. Here is the example: https://github.com/apache/pulsar-site/pull/784
258+
259+
```shell
260+
cd pulsar-site/tools/pytools
261+
poetry run bin/js-apidoc-generator.py 1.X.0
262+
```
263+
264+
#### 11. Announce the release
257265

258266
Once the release artifact is available in the npm registry, we need to announce the release.
259267

0 commit comments

Comments
 (0)