Plugin documentation is worthless

Bug #1735016 reported by Zane Bitter
14
This bug affects 2 people
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://docs.openstack.org/python-openstackclient/latest/cli/command-list.html

However, those projects relegated to the plugin ghetto get only this word salad:

https://docs.openstack.org/python-openstackclient/latest/cli/plugin-commands.html

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.

To post a comment you must log in.
This report contains Public information  
Everyone can see this information.

Other bug subscribers

Remote bug watches

Bug watches keep track of this bug in other bug trackers.