<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=Windows-1252">
</head>
<body style="word-wrap: break-word; -webkit-nbsp-mode: space; -webkit-line-break: after-white-space; color: rgb(0, 0, 0); font-size: 14px; font-family: Calibri, sans-serif; ">
<div>
<div>
<div>I was planning on opening a bug for each CLI to update the help strings. </div>
<div><br>
</div>
<div>In addition to making the language consistent and accurate, I wanted to indicate which commands are admin-only. </div>
<div><br>
</div>
<div>What do you think?</div>
<div>
<div>
<div style="color: rgb(0, 0, 0); "><font class="Apple-style-span" color="rgb(0, 0, 0)" face="Apple Chancery"><i>Diane</i></font></div>
<div style="font-family: Calibri, sans-serif; font-size: 14px; color: rgb(0, 0, 0); ">
<font class="Apple-style-span" color="rgb(0, 0, 0)"><i>----------------------------------------------</i></font></div>
<div style="font-family: Calibri, sans-serif; font-size: 14px; color: rgb(0, 0, 0); ">
<font class="Apple-style-span" color="rgb(0, 0, 0)">Diane Fleming</font></div>
<div style="font-family: Calibri, sans-serif; font-size: 14px; ">
<div style="color: rgb(0, 0, 0); ">Software Developer II - US</div>
</div>
diane.fleming@rackspace.com</div>
<div>Cell 512.323.6799</div>
<div>Office 512.874.1260<br>
<span class="Apple-style-span" style="font-family: Calibri, sans-serif; ">
<div style="font-family: Calibri, sans-serif; font-size: 14px; ">
<div style="color: rgb(0, 0, 0); ">Skype drfleming0227</div>
<div style="color: rgb(0, 0, 0); ">Google-plus diane.fleming@gmail.com</div>
</div>
</span></div>
</div>
</div>
</div>
<div><br>
</div>
<span id="OLK_SRC_BODY_SECTION">
<div style="font-family:Calibri; font-size:11pt; text-align:left; color:black; BORDER-BOTTOM: medium none; BORDER-LEFT: medium none; PADDING-BOTTOM: 0in; PADDING-LEFT: 0in; PADDING-RIGHT: 0in; BORDER-TOP: #b5c4df 1pt solid; BORDER-RIGHT: medium none; PADDING-TOP: 3pt">
<span style="font-weight:bold">From: </span>Anne Gentle <<a href="mailto:anne@openstack.org">anne@openstack.org</a>><br>
<span style="font-weight:bold">Date: </span>Monday, February 3, 2014 8:14 AM<br>
<span style="font-weight:bold">To: </span>Diane Fleming <<a href="mailto:diane.fleming@rackspace.com">diane.fleming@rackspace.com</a>><br>
<span style="font-weight:bold">Cc: </span>Summer Long <<a href="mailto:slong@redhat.com">slong@redhat.com</a>>, Andreas Jaeger <<a href="mailto:aj@suse.com">aj@suse.com</a>>, "<a href="mailto:openstack-docs@lists.openstack.org">openstack-docs@lists.openstack.org</a>"
<<a href="mailto:openstack-docs@lists.openstack.org">openstack-docs@lists.openstack.org</a>>, Steve Gordon <<a href="mailto:sgordon@redhat.com">sgordon@redhat.com</a>><br>
<span style="font-weight:bold">Subject: </span>Re: [Openstack-docs] Proposal: CLI Reference manual<br>
</div>
<div><br>
</div>
<div>
<div>
<div dir="ltr"><br>
<div class="gmail_extra"><br>
<br>
<div class="gmail_quote">On Mon, Feb 3, 2014 at 8:09 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">
I don't think CLI reference should be part of config reference. Two different audiences and CLI commands are used by a broad audience who would probably never think to look in that book for CLI info (even if the title changes). My two cents!<br>
<br>
<br>
</blockquote>
<div><br>
</div>
<div>Agreed -- I think the keyword of that title is Configuration so people wouldn't think to look there. Let's not expose our autodoc victory to our readers by combining the two just because they're both automated. :)</div>
<div><br>
</div>
<div>Summer, I think the heart of your concern lies with the admin/end-user split? Is there another way to address that? </div>
<div><br>
</div>
<div>Anne</div>
<div><br>
</div>
<blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex">
<br>
Sent from my iPhone<br>
<div class="HOEnZb">
<div class="h5"><br>
> On Feb 3, 2014, at 12:53 AM, "Summer Long" <<a href="mailto:slong@redhat.com">slong@redhat.com</a>> wrote:<br>
><br>
><br>
><br>
> --<br>
> Summer Long<br>
> OpenStack Documentation Lead<br>
> Engineering Content Services<br>
><br>
> Red Hat Asia Pacific<br>
> Brisbane, Austral ia<br>
> <a href="mailto:slong@redhat.com">slong@redhat.com</a> | irc: slong<br>
><br>
> ----- Original Message -----<br>
>> From: "Andreas Jaeger" <<a href="mailto:aj@suse.com">aj@suse.com</a>><br>
>> To: "Summer Long" <<a href="mailto:slong@redhat.com">slong@redhat.com</a>><br>
>> Cc: "Diane Fleming" <<a href="mailto:diane.fleming@RACKSPACE.COM">diane.fleming@RACKSPACE.COM</a>>, "Anne Gentle" <<a href="mailto:anne@openstack.org">anne@openstack.org</a>>,<br>
>> <a href="mailto:openstack-docs@lists.openstack.org">openstack-docs@lists.openstack.org</a>, "Steve Gordon" <<a href="mailto:sgordon@redhat.com">sgordon@redhat.com</a>><br>
>> Sent: Monday, February 3, 2014 4:34:44 PM<br>
>> Subject: Re: [Openstack-docs] Proposal: CLI Reference manual<br>
>><br>
>>> On 02/03/2014 03:59 AM, Summer Long wrote:<br>
>>><br>
>>><br>
>>> ----- Original Message -----<br>
>>>> From: "Andreas Jaeger" <<a href="mailto:aj@suse.com">aj@suse.com</a>><br>
>>>> To: "Diane Fleming" <<a href="mailto:diane.fleming@RACKSPACE.COM">diane.fleming@RACKSPACE.COM</a>>, "Anne Gentle"<br>
>>>> <<a href="mailto:anne@openstack.org">anne@openstack.org</a>><br>
>>>> Cc: <a href="mailto:openstack-docs@lists.openstack.org">openstack-docs@lists.openstack.org</a><br>
>>>> Sent: Friday, January 31, 2014 1:44:04 AM<br>
>>>> Subject: Re: [Openstack-docs] Proposal: CLI Reference manual<br>
>>>><br>
>>>>> On 01/30/2014 04:26 PM, Diane Fleming wrote:<br>
>>>>> Actually, I'm fine either way – keeping it as appendix or as separate<br>
>>>>> book.<br>
>>>>><br>
>>>>> But either way, I think we need to improve the formatting – I'll open a<br>
>>>>> bug for that.<br>
>>><br>
>>> And can the 'install the clients' section be removed? Clients should<br>
>>> already be installed via the Installation Guide?<br>
>><br>
>> Clients will be installed on machines outside of the cloud as well, so I<br>
>> think this really belongs to the CLI reference.<br>
> Yep, ok, fair enough.<br>
>><br>
>>>><br>
>>>> Yes, please do open a bug. I'll see what I can do to improve it.<br>
>>>><br>
>>>>> What does everyone else think about keeping command ref as appendix, or<br>
>>>>> moving to separate book?<br>
>>>><br>
>>>> I'm fine either way. Having one more guide, will not really cost us<br>
>>>> more work than having it in the appendices. And having a guide would<br>
>>>> give us *one* location for the content instead of currently two guides<br>
>>>> with both the same large appendix.<br>
>>> Definitely vote for having it<br>
>>><br>
>>>><br>
>>>> And I'm even fine with removing the appendix and not having a book since<br>
>>>> these are help texts users could get themselves on the command line...<br>
>>>> Still, it's nice to have a common location to look it up and be aware of<br>
>>>> these. And since there are no man pages for these, this it probably the<br>
>>>> best way to have it,<br>
>>><br>
>>> +1 on removing the CLI info from both EUG and AUG and providing links<br>
>>> (really dislike bloat-by-duplication).<br>
>>><br>
>>> But was there a reason for not just putting the CLI info into the<br>
>>> Configuration Reference Guide?<br>
>>> We're removing the HowTos from that guide, which means the whole thing<br>
>>> really is a reference now?<br>
>><br>
>> IMO they target different personas - the admin of the cloud for the<br>
>> Configuration Reference only and the CLI reference both admin and users,<br>
> But if you do this, you're creating an admin-and-users book. Why not just make the Configuration Reference have that audience as well and keep all the automatically generated reference lists in one book? 'Configuration and CLI Reference'<br>
><br>
> cheers, Summer<br>
><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/Identica: 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>
</div>
</div>
</blockquote>
</div>
<br>
</div>
</div>
</div>
</div>
</span>
</body>
</html>