[OpenStack-docs] how is cli-ref generated?

Lana Brindley openstack at lanabrindley.com
Wed Aug 31 22:32:49 UTC 2016


There's also info here: http://docs.openstack.org/contributor-guide/doc-tools/cli-reference.html

L

On 01/09/16 03:48, Steve Martinelli wrote:
> for reference, the help that the docs team publishes is here: http://docs.openstack.org/cli-reference/openstack.html
> 
> and the one that the OSC team publishes is here: http://docs.openstack.org/developer/python-openstackclient/command-list.html
> 
> I was under the impression that the first one (published by the docs team) was done with automation
> 
> On Wed, Aug 31, 2016 at 1:36 PM, Akihiro Motoki <amotoki at gmail.com <mailto:amotoki at gmail.com>> wrote:
> 
>     Hi,
> 
>     I wonder how CLI reference is generated?
>     I looked for some document on the process of the CLI reference but I
>     failed to find it.
> 
>     This question mainly comes from the following two.
> 
>     (1) Why the process is not automated?
>     I see a lot of patches to CLI reference when new version of CLIs are release.
>     I wonder why they are not automated.
> 
>     (2) Duplicated information on OSC
>     OSC provides useful and detail command line help in their devref.
>     OSC CLI reference in openstack-manuals looks like a duplicated effort.
>     If the docs team has not talked with OSC team, it means a lack of
>     communications.
> 
>     Anyway, I think we should try and explore more automated way
>     rather than spend time to keep them up-to-date manually.
> 
>     Thought?
> 
>     Thanks,
>     Akihiro
> 
>     _______________________________________________
>     OpenStack-docs mailing list
>     OpenStack-docs at lists.openstack.org <mailto:OpenStack-docs at lists.openstack.org>
>     http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs <http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs>
> 
> 
> 
> 
> _______________________________________________
> OpenStack-docs mailing list
> OpenStack-docs at lists.openstack.org
> http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs
> 

-- 
Lana Brindley
Technical Writer
Rackspace Cloud Builders Australia
http://lanabrindley.com

-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 538 bytes
Desc: OpenPGP digital signature
URL: <http://lists.openstack.org/pipermail/openstack-docs/attachments/20160901/b311f8d6/attachment-0001.pgp>


More information about the OpenStack-docs mailing list