search

longhorn / longhorn

Cloud-Native distributed storage built on and for Kubernetes
https://longhorn.io
Apache License 2.0
5.93k stars 584 forks source link

[IMPROVEMENT] Enhance menu descriptions for Longhorn CLI #8998

Open c3y1huang opened 1 month ago

c3y1huang commented 1 month ago

Is your improvement request related to a feature? Please describe (👍 if you like this request)

The Longhorn CLI help menu descriptions are currently written by developers. It would be great if we could improve these descriptions by leveraging the expertise of our doc team (@longhorn/doc) .

Describe the solution you'd like

Enhance the Longhorn CLI help menu descriptions for the main command and subcommands, the scope includes short summaries, verbose explanations, and option flag details.

After updating the help menu descriptions, run make to auto-generate the docs.

Describe alternatives you've considered

None

Additional context

https://github.com/longhorn/cli/pull/34#pullrequestreview-2176798545

c3y1huang commented 1 month ago

cc @derekbit

derekbit commented 1 month ago

@jillian-maroket Can you help handle the ticket? Thank you.

derekbit commented 1 month ago

@jhkrug could you take over the ticket? Thanks.

jhkrug commented 1 month ago

So, whats to do here? It seems like the associated PR was merged. Is the issue finished? Are there more PRs coming for this? @derekbit

derekbit commented 1 month ago

So, whats to do here? It seems like the associated PR was merged. Is the issue finished? Are there more PRs coming for this? @derekbit

Hello @jhkrug As the description mentioned, you can create new PRs for refining the descriptions and docs in the PRs.