Skip to content

[Website] generate CLI docs for minor releases  #12211

@Anonymitaet

Description

@Anonymitaet

Issue

Currently, automatic CLI docs (pulsar-client, pulsar-perf, and pulsar) are only available for major releases.

For example,

image

image

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!

image

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions