<div dir="ltr"><div class="gmail_extra"><div class="gmail_quote">On Thu, Sep 1, 2016 at 4:30 PM, Steve Martinelli <span dir="ltr"><<a href="mailto:s.martinelli@gmail.com" target="_blank">s.martinelli@gmail.com</a>></span> wrote:<br><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex"><div dir="ltr">cc'ed dtroyer (osc ptl)<div><br></div><div>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 <a href="http://docs.openstack.org/cli-reference/openstack.html" target="_blank">http://docs.openstack.org/cli-<wbr>reference/openstack.html</a> and <a href="http://docs.openstack.org/developer/python-openstackclient/command-list.html" target="_blank">http://docs.openstack.org/<wbr>developer/python-<wbr>openstackclient/command-list.<wbr>html</a></div></div></blockquote><div><br></div><div>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?</div><div><br></div><div>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.</div><div><br></div><div>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.</div><div><br></div><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex"><div class="gmail_extra"><div class="gmail_quote"><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex"><div><div>
On 02/09/16 03:19, Akihiro Motoki wrote:<br>
> OSC also recently introduced "beta" command concept [1].<br>
> Another point is how the cli-ref provided by openstack-manuals treats it.<br>
> [1] <a href="http://docs.openstack.org/developer/python-openstackclient/command-beta.html" rel="noreferrer" target="_blank">http://docs.openstack.org/deve<wbr>loper/python-openstackclient/<wbr>command-beta.html</a></div></div></blockquote></div></div></blockquote><div><br></div><div>Please do not document beta commands in end-user-visible places.  These commands are specifically made with the enable switch so they do not get picked up before they are ready for general use.</div><div><br></div><div>dt</div></div><div><br></div>-- <br><div class="gmail_signature" data-smartmail="gmail_signature"><br>Dean Troyer<br><a href="mailto:dtroyer@gmail.com" target="_blank">dtroyer@gmail.com</a><br></div>
</div></div>