Make pmm-admin --help more user-friendly
General
Escalation
General
Escalation
Description
How to test
None
How to document
None
Attachments
1
Smart Checklist
Activity
Show:

Vladimir Nazarov August 25, 2022 at 1:42 PMEdited
Autotest are fixed
https://pmm.cd.percona.com/job/pmm2-testsuite/10587/

Michal August 22, 2022 at 9:51 AM
Vladimir is resolving issues in automated tests.

Michal August 11, 2022 at 9:10 AM
this ticket is not blocked by .
is blocked by this ticket.

Taras Kozub July 25, 2022 at 1:25 PM
Flag added
blocked by https://jira.percona.com/browse/PMM-9599
Done
Details
Details
Assignee
Unassigned
UnassignedReporter

Priority
Components
Labels
Needs QA
Yes
Needs Doc
No
Story Points
3
Affects versions
Smart Checklist
Open Smart Checklist
Smart Checklist

Open Smart Checklist
Created June 7, 2022 at 12:20 PM
Updated March 6, 2024 at 1:08 AM
Resolved August 25, 2022 at 1:56 PM
What should be done
Move detailed help for the "pmm-admin add" command under "pmm-admin add --help".
Hide additional information in "pmm-admin --help" command, in the "add external-serverless" section (see screenshot), but keep it in "pmm-admin add external-serverless --help"
Sort commands in "pmm-admin --help" and the subcommands alphabetically keeping "help" command first
Why
Currently all subcommands are listed which makes it confusing when trying to understand which commands are available on the top level.
The help is confusing and a lot of text when user is not asked for this
Benefit
Easier to understand and cleaner help documentation
Details
Current state
Suggested state