Comment 4 for bug 1627881

Revision history for this message
Michael Foster (mfosterm) wrote :

Thanks for the feedback. I found the Change-ID that removed all of the content (Change-Id: I0e530e93ac1ce0f273562561465794d4dc460036) and the discussion you were referring to [1].

I can see the point of trying to reduce duplication. However, as an end-user, having all of the information in one place is crucial. As I mentioned, the developer page is woefully incomplete.
Additionally, since the trend is to be migration away from the individual clients to the centralized openstack client, there needs to be documentation for it, especially since some commands are not 1-for-1. Trying to find an openstack cli equivalent is made harder when you can't search on a specific term unless you know which command you need help with. I often find myself searching for a command-line switch to find what the actual command is. A trivial example would be trying to set a tag on a glance image. The glance cli uses "image-tag-update", but the openstack cli uses the image-set command.

As an aside, end-user guides or admin guides for any of the supported projects should not redirect to developer documentation which is often terse and/or incomplete. For example trying to comprehensive docs on how to install or even use some projects like trove or manila is like pulling teeth. The "official" guides should be self-contained and as comprehensive as possible.

Apologies if this was too much of a rant. Thanks for looking.

[1] http://lists.openstack.org/pipermail/openstack-docs/2016-September/009095.html