Skip to content

[Website] generate "Pulsar command-line tools" page from code automatically #10040

Closed
@Anonymitaet

Description

Our community has developed many features and enhancements for Pulsar command-line tools (for example, adding various commands and flags, that is great!)

However, docs are always ignored and lag behind the code. This might be caused by that devs do not want to add this kind of docs manually, which is an inefficient way. So may I suggest generating the contents of the Pulsar command-line tools page from the code automatically? It might need to develop some automatic tools.

This is an example: https://github.com/apache/pulsar/pull/5738/files

preview: http://pulsar.apache.org/tools/pulsar-admin/2.7.0-SNAPSHOT/

Can anyone take care of this?
Your help is much appreciated, thanks.

P.S. Task management: https://docs.google.com/spreadsheets/d/1P6tePGmU1lEhGKY_hE3JWgJ1rUTBCmW7AshDICJZr3o/edit#gid=1030826289

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