-
Notifications
You must be signed in to change notification settings - Fork 3.7k
Description
Issue
Currently, automatic CLI docs (pulsar-client, pulsar-perf, and pulsar) are only available for major releases.
For example,
- If click
Pulsar Perfonnextversion, it goes to the https://pulsar.apache.org/tools/pulsar-perf/2.9.0-SNAPSHOT/ (this page is generated automatically), which is the correct behavior.
- But if click
Pulsar Perfon2.8.1version, it goes to the https://pulsar.apache.org/docs/en/reference-cli-tools/#pulsar-perf (this page is maintained manually), which is not the expected behavior. We expect minor releases have their corresponding "automatically generated pages".
Potential solution
I've discussed this issue with @tuteng and @urfreespace, we have the following solutions:
Solution 1: build CLI docs for minor releases automatically based on tag
Currently, CLI tool docs (websites) are automatically generated based on the branch (master). Building these websites consumes resources. To generate CLI docs for minor releases, we can change it to based on tag. We have many minor releases so we have many tags, which means consuming much more resources and taking too long to build websites. So this makes us think it is not a good solution.
Solution 2: build CLI docs for minor releases manually
Another way is to create content for minor releases manually under the asf-site branch.
For example,
We can create different folders for each minor release and then copy contents there, so that the CLI tool websites can be generated as well. But it takes some time to investigate how to implement it. Can anyone help with this? Or anyone has a better solution? Many thanks!


