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

Kato, Tomoyuki kato.tomoyuki at jp.fujitsu.com
Mon Sep 5 13:25:55 UTC 2016

> [snip]
> 	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
> <http://docs.openstack.org/cli-reference/openstack.html>  and
> http://docs.openstack.org/developer/python-openstackclient/command-lis
> t.html
> <http://docs.openstack.org/developer/python-openstackclient/command-li
> st.html>
> I don't agree with removing the docs from the OSC repo, we try to require
> docs updates in the same review as code changes, that will be impossible
> otherwise and the published docs will always lag.  How will the docs.o.o
> version be maintained current?
> If there is something we can do to facilitate a periodic update of docs.o.o,
> I am all for it, be it on every commit or at release time (we release as-needed,
> not on the integrated cycle), which is my preference.
> Also note that our current RST docs contain more than just a one-for-one
> of the help output.  It should contain MUCH more in the way of explanation.
> [snip]

I'd like to use the OSC repo for primarily document, too.
Thanks for taking up this issue.

KATO Tomoyuki

More information about the OpenStack-docs mailing list