Plugin documentation is worthless
Affects | Status | Importance | Assigned to | Milestone | |
---|---|---|---|---|---|
python-openstackclient |
New
|
Undecided
|
Unassigned |
Bug Description
Those projects considered important enough by the self-appointed maintainers of openstackclient to consitute 'real' OpenStack have decent documentation, with a list of commands arranged by noun type that link to full documentation including command syntax and parameters:
https:/
However, those projects relegated to the plugin ghetto get only this word salad:
https:/
This is just a list of entry points - which mean nothing to the user. There is no clue about the command syntax or parameters, or even links that could allow that documentation to be hosted elsewhere.
If there is an existing way to properly document plugin commands, there are no instructions for that and no plugin has actually done it.