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

Anne Gentle annegentle at justwriteclick.com
Fri Sep 2 12:59:32 UTC 2016


On Fri, Sep 2, 2016 at 5:13 AM, Andreas Jaeger <aj at suse.com> wrote:

> On 09/01/2016 11:30 PM, Steve Martinelli wrote:
> > cc'ed dtroyer (osc ptl)
> >
> > Duplication is a part of Akihiro's initial comment, and I think the the
> > OSC shouldn't maintain it's own copy of this, but rather redirect to the
> > docs page. I'd be more than happy to get rid of the OSC docs, before
> > doing that I did a quick comparison between
> > http://docs.openstack.org/cli-reference/openstack.html
> > and http://docs.openstack.org/developer/python-
> openstackclient/command-list.html
> >
> > The only information that I see missing is that in the OSC docs we mark
> > some options (and commands) as being specific to an API version. For
> > instance, in "volume type create", the description, public, private, and
> > project options are only supported for the Volume V2 API (we (OSC) can't
> > do anything about this limitation). We document this limitation as such
> > here: http://docs.openstack.org/developer/python-
> openstackclient/command-objects/volume-type.html#volume-type-create
> > but it is not reflected
> > here: http://docs.openstack.org/cli-reference/openstack.html#
> openstack-volume-type-create
> >
> > If we can resolve this issue, then I think we can remove the docs from
> > OSCs page.
>
> Alternative is to stop publishing the cli-guide - and publish only from
> osc. We could publish the documents from osc in a different place - or
> link to them differently,
>

I agree with Dean's assessment and this is a great next project to move
from central to distributed -- the CLI ref. I'd like to hear more from
others but right now I like this direction.

Anne


>
> Andreas
> --
>  Andreas Jaeger aj@{suse.com,opensuse.org} Twitter/Identica: jaegerandi
>   SUSE LINUX GmbH, Maxfeldstr. 5, 90409 Nürnberg, Germany
>    GF: Felix Imendörffer, Jane Smithard, Graham Norton,
>        HRB 21284 (AG Nürnberg)
>     GPG fingerprint = 93A3 365E CE47 B889 DF7F  FED1 389A 563C C272 A126
>
>
> _______________________________________________
> OpenStack-docs mailing list
> OpenStack-docs at lists.openstack.org
> http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs
>



-- 
Anne Gentle
www.justwriteclick.com
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.openstack.org/pipermail/openstack-docs/attachments/20160902/eb7c6500/attachment.html>


More information about the OpenStack-docs mailing list