<html><body><div style="color:#000; background-color:#fff; font-family:HelveticaNeue, Helvetica Neue, Helvetica, Arial, Lucida Grande, sans-serif;font-size:12px"><div id="yui_3_16_0_1_1432936970446_15853" dir="ltr">I'll go along with the wishes of the majority but I do agree with Amanda here, that capitalizing the names of the projects</div><div id="yui_3_16_0_1_1432936970446_15822" dir="ltr">would make both the writing and the reading easier.</div><div id="yui_3_16_0_1_1432936970446_15823" dir="ltr"><br></div><div id="yui_3_16_0_1_1432936970446_15824" dir="ltr">What about services that are not projects per se, such as HAProxy, MySQL, MongoDB, Pacemaker, Corosync...? Some of these exist</div><div id="yui_3_16_0_1_1432936970446_15821" dir="ltr">outside the OpenStack world and everyone is used to them being capitalized in a certain way. But it seems quite awkward</div><div id="yui_3_16_0_1_1432936970446_15827" dir="ltr">to capitalize these when services that are projects are not capitalized.<br></div><div id="yui_3_16_0_1_1432936970446_15723" dir="ltr"><br></div><div id="yui_3_16_0_1_1432936970446_15724" dir="ltr">I just went through a piece of doc and changed HAProxy to haproxy. The title of the section is "HAProxy nodes" so I had to</div><div id="yui_3_16_0_1_1432936970446_15854" dir="ltr">make that "Haproxy nodes" to conform to the standard for capitalization in headers. I suppose I could rewrite it to be "The haproxy nodes"</div><div id="yui_3_16_0_1_1432936970446_15855" dir="ltr">but I would much prefer to have the keyword begin the header.<br></div><div id="yui_3_16_0_1_1432936970446_15424"><br><span></span></div><div dir="ltr" id="yui_3_16_0_1_1432936970446_15885"><span id="yui_3_16_0_1_1432936970446_15886">As I said, I'll go along but Amanda deserves a little support ;-)</span></div><div dir="ltr"><span>meg</span></div><br> <blockquote id="yui_3_16_0_1_1432936970446_15428" style="border-left: 2px solid rgb(16, 16, 255); margin-left: 5px; margin-top: 5px; padding-left: 5px;"> <div id="yui_3_16_0_1_1432936970446_15427" style="font-family: HelveticaNeue, Helvetica Neue, Helvetica, Arial, Lucida Grande, sans-serif; font-size: 12px;"> <div id="yui_3_16_0_1_1432936970446_15426" style="font-family: HelveticaNeue, Helvetica Neue, Helvetica, Arial, Lucida Grande, sans-serif; font-size: 16px;"> <div id="yui_3_16_0_1_1432936970446_15425" dir="ltr"> <hr size="1"> <font id="yui_3_16_0_1_1432936970446_15441" face="Arial" size="2"> <b><span style="font-weight:bold;">From:</span></b> Anne Gentle <annegentle@justwriteclick.com><br> <b><span style="font-weight: bold;">To:</span></b> APlimpton <aplimpton@gmail.com> <br><b><span style="font-weight: bold;">Cc:</span></b> "openstack-docs@lists.openstack.org" <openstack-docs@lists.openstack.org> <br> <b><span style="font-weight: bold;">Sent:</span></b> Friday, May 29, 2015 2:56 PM<br> <b><span style="font-weight: bold;">Subject:</span></b> Re: [OpenStack-docs] Style Question for Project Names<br> </font> </div> <div id="yui_3_16_0_1_1432936970446_15462" class="y_msg_container"><br><div id="yiv7758721855"><div id="yui_3_16_0_1_1432936970446_15461" dir="ltr"><br><div id="yui_3_16_0_1_1432936970446_15460" class="yiv7758721855gmail_extra"><br><div id="yui_3_16_0_1_1432936970446_15459" class="yiv7758721855gmail_quote">On Fri, May 29, 2015 at 4:36 PM, APlimpton <span dir="ltr"><<a rel="nofollow" ymailto="mailto:aplimpton@gmail.com" target="_blank" href="mailto:aplimpton@gmail.com">aplimpton@gmail.com</a>></span> wrote:<br><blockquote id="yui_3_16_0_1_1432936970446_15458" class="yiv7758721855gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex;"><div id="yui_3_16_0_1_1432936970446_15457" dir="ltr"><div id="yui_3_16_0_1_1432936970446_15887">I see several people are fine with how the convention is and would prefer for it to remain as is because they do not see a need for the change. </div><div><br></div><div id="yui_3_16_0_1_1432936970446_15500">Because I do see a need, the burden is on me to further explain what I’m seeing and why it suggests that using a capital letter with the project names is needed. </div><div><br></div><div id="yui_3_16_0_1_1432936970446_15456">When I say inconsistencies I mean that a handful of the OpenStack documentation manuals and a few wiki pages use the lowercase. On all other guides, references, manuals, websites, pages, blogs and various other communications the capitalized letter is used by the community (OpenStack and general). This strong majority of people using the capitalized version indicates that there has been a shift in the usage and we should update our convention accordingly. </div><div id="yui_3_16_0_1_1432936970446_15501"><br></div><div>This is supported by the fact that these project names are names/proper nouns and as such should be capitalized. Having the release code names capitalized but not the project code names is inconsistent. If the name is to be a proper noun w/ all lowercase then all sentences that start with the project name will need to be reworded (source: IBM Style Guide used per the Conventions wiki page). </div><div><br></div><div id="yui_3_16_0_1_1432936970446_15463">An additional benefit to using the initial uppercase with project names is that it helps reduce confusion. Each project uses the project name three distinct ways with the exact same case. The project name, the CLI name and the command that is used. For example: nova, nova, nova. As a component of the project, the CLI name and the command should be lowercase (source: IBM Style Guide). Using a capitalized letter with the project name immediately distinguishes it as being not the project component and helps make sentence creation and updating less convoluted.</div><div><br></div><div>If this makes sense to most of you and the consensus is reached to change to the initial uppercase I will be happy to find and make those changes. If the consensus is to keep it all lowercase then I’ll go ahead and attempt correction for the majority of docs, which will take a little longer. If keeping all lowercase, it may also be a good idea to remind the other contributors about the conventions page so they will be aware in the future. Either way I am believer in consistency and clarity. :)</div></div></blockquote><div><br></div><div id="yui_3_16_0_1_1432936970446_15502">Agreed. Thanks for bringing the issue forward. Even when writing a blog post for the Rackspace blog two weeks ago, I had two editors tell me to capitalize the project/team name. However they were fine with lowercase once I pointed out our conventions. We have the power to enforce lowercase so why not put your energy towards the lowercase preference that we've had for years?</div><div><br></div><div id="yui_3_16_0_1_1432936970446_15464">One rule we have for simplicity's sake is to use sentence case for all titles, and the reasoning behind this is that it's fewer rules to explain and enforce (plus there are two competing Title Case styles from certain references). I sense we have the same simplicity goal with "always lower case project names" because once people start uppercasing what they think is Important then Everything Is Important if you Know what I Mean. :)</div><div><br></div><div>I'd ask you to activate towards lowercase and help enforce that as standard rather than advocating for Upper Case All the Time. </div><div><br></div><div>Really though, I said I'd get out of the way on this one. Hope my reasoning makes sense.</div><div>Anne</div><div> </div><blockquote id="yui_3_16_0_1_1432936970446_15472" class="yiv7758721855gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex;"><div dir="ltr"><div><br></div><div>Thanks,<br>Amanda</div></div><div id="yui_3_16_0_1_1432936970446_15471" class="yiv7758721855HOEnZb"><div id="yui_3_16_0_1_1432936970446_15470" class="yiv7758721855h5"><div id="yui_3_16_0_1_1432936970446_15469" class="yiv7758721855gmail_extra"><br><div id="yui_3_16_0_1_1432936970446_15468" class="yiv7758721855gmail_quote">On Fri, May 29, 2015 at 1:37 PM, Shilla Saebi <span dir="ltr"><<a rel="nofollow" ymailto="mailto:shilla.saebi@gmail.com" target="_blank" href="mailto:shilla.saebi@gmail.com">shilla.saebi@gmail.com</a>></span> wrote:<br><blockquote id="yui_3_16_0_1_1432936970446_15467" class="yiv7758721855gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex;">+1<br>
<br>
Sent from my iPhone<br>
<div id="yui_3_16_0_1_1432936970446_15466"><div id="yui_3_16_0_1_1432936970446_15465"><br>
> On May 29, 2015, at 4:22 PM, Christian Berendt <<a rel="nofollow" ymailto="mailto:christian@berendt.io" target="_blank" href="mailto:christian@berendt.io">christian@berendt.io</a>> wrote:<br>
><br>
>> On 05/29/2015 09:40 PM, Andreas Jaeger wrote:<br>
>> We're following the current convention for some time already and I see<br>
>> no reason to change, let's keep the current convention. If there're<br>
>> problems, let's fix them...<br>
><br>
> +1<br>
><br>
> --<br>
> Christian Berendt<br>
> Cloud Computing Solution Architect<br>
> Mail: <a rel="nofollow" ymailto="mailto:berendt@b1-systems.de" target="_blank" href="mailto:berendt@b1-systems.de">berendt@b1-systems.de</a><br>
><br>
> B1 Systems GmbH<br>
> Osterfeldstraße 7 / 85088 Vohburg / <a rel="nofollow" target="_blank" href="http://www.b1-systems.de/">http://www.b1-systems.de</a><br>
> GF: Ralph Dehner / Unternehmenssitz: Vohburg / AG: Ingolstadt,HRB 3537<br>
><br>
> _______________________________________________<br>
> OpenStack-docs mailing list<br>
> <a rel="nofollow" ymailto="mailto:OpenStack-docs@lists.openstack.org" target="_blank" href="mailto:OpenStack-docs@lists.openstack.org">OpenStack-docs@lists.openstack.org</a><br>
> <a rel="nofollow" target="_blank" href="http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs">http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs</a><br>
<br>
_______________________________________________<br>
OpenStack-docs mailing list<br>
<a rel="nofollow" ymailto="mailto:OpenStack-docs@lists.openstack.org" target="_blank" href="mailto:OpenStack-docs@lists.openstack.org">OpenStack-docs@lists.openstack.org</a><br>
<a rel="nofollow" target="_blank" href="http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs">http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs</a><br>
</div></div></blockquote></div><br></div>
</div></div><br>_______________________________________________<br>
OpenStack-docs mailing list<br>
<a rel="nofollow" ymailto="mailto:OpenStack-docs@lists.openstack.org" target="_blank" href="mailto:OpenStack-docs@lists.openstack.org">OpenStack-docs@lists.openstack.org</a><br>
<a rel="nofollow" target="_blank" href="http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs">http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs</a><br>
<br></blockquote></div><br><br clear="all"><div><br></div>-- <br><div class="yiv7758721855gmail_signature">Anne Gentle<br><a rel="nofollow" ymailto="mailto:annegentle@justwriteclick.com" target="_blank" href="mailto:annegentle@justwriteclick.com">annegentle@justwriteclick.com</a></div>
</div></div></div><br>_______________________________________________<br>OpenStack-docs mailing list<br><a ymailto="mailto:OpenStack-docs@lists.openstack.org" 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></div> </div> </div> </blockquote> </div></body></html>