<div dir="ltr"><br><div class="gmail_extra"><br><br><div class="gmail_quote">On Thu, Jan 30, 2014 at 8:53 AM, Diane Fleming <span dir="ltr"><<a href="mailto:diane.fleming@rackspace.com" target="_blank">diane.fleming@rackspace.com</a>></span> wrote:<br>
<blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex">Andreas,<br>
<br>
After looking at the new CLI reference, I'm okay with having it as a<br>
separate book and removing the appendices from the End User Guide and<br>
Admin User Guide.<br>
<br>
However, I do think we could do more work to improve the formatting of the<br>
Command Reference - I can suggest a format for the output. That will<br>
involve more coding work, but I think it would be worth it.<br>
<br>
However, for the time being, this is still a huge improvement, so I think<br>
we should push through the current version.<br>
<br>
The enhanced command reference is 200 pages, so it's probably best to<br>
remove it from the user guides, and provide pointers from those guides to<br>
the new Command Reference.<br>
<br>
So I recommend:<br>
<br>
1. Update Command Reference to use same ch_cli.xml file as End User Guide,<br>
with conditions to omit unneeded content.<br>
Then, push through current version of Command Reference. One version<br>
(trunk), and no release-centric versions.<br>
2. Remove appendices from user guides, and include pointers to new Command<br>
Reference. However, leave the ch_cli.xml as is in both those books.<br>
(Don't remove installation instructions for CLIs.)<br>
3. New bug to improve formatting in Command Reference.<br>
<br></blockquote><div><br></div><div>I can be convinced of this too -- and it's pretty much what we discussed at the Hong Kong Summit. :) Thanks!</div><div>Anne</div><div> </div><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex">
My two cents!<br>
<br>
<br>
Diane<br>
----------------------------------------------<br>
Diane Fleming<br>
Software Developer II - US<br>
<br>
<a href="mailto:diane.fleming@rackspace.com">diane.fleming@rackspace.com</a><br>
Cell <a href="tel:512.323.6799" value="+15123236799">512.323.6799</a><br>
Office <a href="tel:512.874.1260" value="+15128741260">512.874.1260</a><br>
Skype drfleming0227<br>
Google-plus <a href="mailto:diane.fleming@gmail.com">diane.fleming@gmail.com</a><br>
<div class="HOEnZb"><div class="h5"><br>
<br>
<br>
<br>
<br>
<br>
On 1/30/14 8:35 AM, "Andreas Jaeger" <<a href="mailto:aj@suse.com">aj@suse.com</a>> wrote:<br>
<br>
>On 01/29/2014 08:31 PM, Andreas Jaeger wrote:<br>
>> As discussed in today's IRC meeting and as a followup to the Hongkong<br>
>> summit (see [1]), I've drafted a CLI Reference.<br>
>><br>
>> Patch is available here:<br>
>> <a href="https://review.openstack.org/#/c/69942/" target="_blank">https://review.openstack.org/#/c/69942/</a><br>
>><br>
>> A complete manual is published for review at:<br>
>> <a href="http://users.suse.com/~aj/cli-reference/content" target="_blank">http://users.suse.com/~aj/cli-reference/content</a><br>
><br>
>So, the question is: Is this the right way forward:<br>
><br>
>* Do we want to have the guide as proposed at all?<br>
><br>
>* What needs to be done to make it better?<br>
><br>
>* Should we remove the appendices from the End User Guide and the Admin<br>
>User Guide that contain the same content (and add appropriate pointers<br>
>to the book)?<br>
><br>
>* Is this really a continuously publishing book? Since the libraries are<br>
>continuously published, I suggest that we have it only one version (so<br>
>no havana/icehouse etc version).<br>
><br>
>Andreas<br>
>--<br>
> Andreas Jaeger aj@{<a href="http://suse.com" target="_blank">suse.com</a>,<a href="http://opensuse.org" target="_blank">opensuse.org</a>} Twitter: jaegerandi<br>
> SUSE LINUX Products GmbH, Maxfeldstr. 5, 90409 Nürnberg, Germany<br>
> GF: Jeff Hawn,Jennifer Guild,Felix Imendörffer,HRB16746 (AG Nürnberg)<br>
> GPG fingerprint = 93A3 365E CE47 B889 DF7F FED1 389A 563C C272 A126<br>
><br>
>_______________________________________________<br>
>Openstack-docs mailing list<br>
><a href="mailto:Openstack-docs@lists.openstack.org">Openstack-docs@lists.openstack.org</a><br>
><a href="http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs" target="_blank">http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs</a><br>
<br>
<br>
_______________________________________________<br>
Openstack-docs mailing list<br>
<a href="mailto:Openstack-docs@lists.openstack.org">Openstack-docs@lists.openstack.org</a><br>
<a href="http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs" target="_blank">http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs</a><br>
</div></div></blockquote></div><br></div></div>