<div dir="ltr">Hi all, <div>Renamed the thread to get some topics in the subject, and I wanted to bring this review to everyone's attention. </div><div><br></div><div><a href="https://review.openstack.org/#/c/201160/">https://review.openstack.org/#/c/201160/</a><br></div><div><br></div><div>I will reconsider these guidelines based on feedback. That said, I have done the legwork to ask about legal guidance and I still believe that lowercase nearly always is best to reduce cognitive burden.</div><div><br></div><div>Thanks,</div><div>Anne</div><div><div class="gmail_extra"><br><div class="gmail_quote">On Tue, Jul 7, 2015 at 9:36 PM, Anne Gentle <span dir="ltr"><<a href="mailto:annegentle@justwriteclick.com" target="_blank">annegentle@justwriteclick.com</a>></span> wrote:<br><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left-width:1px;border-left-color:rgb(204,204,204);border-left-style:solid;padding-left:1ex"><div dir="ltr"><div class="gmail_extra"><div class="gmail_quote"><span class=""><div> </div><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left-width:1px;border-left-color:rgb(204,204,204);border-left-style:solid;padding-left:1ex">
<br>
-------- Forwarded Message --------<br>
Subject: [openstack-dev] Should project name be uppercase or lowercase?<br>
Date: Tue, 7 Jul 2015 18:21:57 +0900<br>
From: Yuiko Takada <<a href="mailto:yuikotakada0313@gmail.com" target="_blank">yuikotakada0313@gmail.com</a>><br>
Reply-To: OpenStack Development Mailing List (not for usage questions)<br>
<<a href="mailto:openstack-dev@lists.openstack.org" target="_blank">openstack-dev@lists.openstack.org</a>><br>
To: OpenStack Development Mailing List (not for usage questions)<br>
<<a href="mailto:openstack-dev@lists.openstack.org" target="_blank">openstack-dev@lists.openstack.org</a>><br>
<br>
<br>
<br>
Hi folks,<br>
<br>
I found the difference between wiki[1] and governance[2].<br></blockquote><div><br></div></span><div>Yes, we are aware of the differences. I have asked the OpenStack Foundation legal counsel and they do not have a legal reason to capitalize project names. </div><div><br></div><div>So, in documentation for consistency and to work on more valuable efforts, we need to stick to the established Documentation Conventions that have been in place since October 2013.</div><div><br></div><div><a href="https://wiki.openstack.org/wiki/Documentation/Conventions#Service_and_project_names" target="_blank">https://wiki.openstack.org/wiki/Documentation/Conventions#Service_and_project_names</a><br></div><span class=""><div><br></div><div> </div><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left-width:1px;border-left-color:rgb(204,204,204);border-left-style:solid;padding-left:1ex">
wiki says "Generally the capitalization of the project team names like<br>
swift is lowercase."<br>
But in governance, written as uppercase like "Nova", "Swift".<br></blockquote><div><br></div></span><div>I don't believe a machine-readable YAML file indicates style or conventions for capitalization for a collection. </div><div><br></div><div>Yes, I will be doing a patch for service names since it is a source of reference and if we think it will alleviate confusion I'll also lowercase the names of the projects in a separate patch.</div><span class=""><div><br></div><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left-width:1px;border-left-color:rgb(204,204,204);border-left-style:solid;padding-left:1ex">
<br>
How do you think which should we use uppercase vs lowercase for<br>
representing project names?<br></blockquote><div><br></div></span><div>I'll be patching the governance repo with some guidelines we have been using to make them official. The projects.yaml file is the reference point for the service catalog and documentation, and the doc team maintains a lookup list on the wiki page referenced above.</div><div><br></div><div>Conventions for service names: </div><div><ul style="color:rgb(0,0,0);font-family:sans-serif"><li>Uppercase first letter of first word only.</li><li>Do not use OpenStack in the name of the service.</li><li>Use module if it is consuming other services (such as heat).</li><li>Use service in general as that is mostly what is being added as projects.</li></ul></div><div>Conventions for project names:</div><div><ul><li>In documentation published to <a href="http://docs.openstack.org" target="_blank">docs.openstack.org</a>, use lower case for project names <span style="color:rgb(0,0,0);font-family:sans-serif">except at the beginning of a sentence or heading title. (Note that all heading titles use sentence case for ease of learning capitalization rules.)</span></li><li>In the service catalog, use lower case.</li></ul></div><div>I hope this clarification helps. Please let me know if you have any questions or concerns. </div></div></div></div></blockquote><div><br></div><div>Hi again all, </div><div>I have </div><div> </div><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left-width:1px;border-left-color:rgb(204,204,204);border-left-style:solid;padding-left:1ex"><div dir="ltr"><div class="gmail_extra"><div class="gmail_quote"><div><br></div><div>Thanks,</div><div>Anne</div><span class=""><div><br></div><div> </div><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left-width:1px;border-left-color:rgb(204,204,204);border-left-style:solid;padding-left:1ex">
<br>
<br>
[1]<a href="https://wiki.openstack.org/wiki/Documentation/Conventions" rel="noreferrer" target="_blank">https://wiki.openstack.org/wiki/Documentation/Conventions</a><br>
[2]<a href="http://git.openstack.org/cgit/openstack/governance/tree/reference/projects.yaml" rel="noreferrer" target="_blank">http://git.openstack.org/cgit/openstack/governance/tree/reference/projects.yaml</a><br>
<br>
<br>
Best Regards,<br>
Yuiko Takada<span><font color="#888888"><br>
<br>
<br>
<br>
-- <br>
Christian Berendt<br>
Cloud Solution Architect<br>
Tel.: <a href="tel:%2B49-171-5542175" value="+491715542175" target="_blank">+49-171-5542175</a><br>
Mail: <a href="mailto:berendt@b1-systems.de" target="_blank">berendt@b1-systems.de</a><br>
<br>
B1 Systems GmbH<br>
Osterfeldstraße 7 / 85088 Vohburg / <a href="http://www.b1-systems.de" rel="noreferrer" target="_blank">http://www.b1-systems.de</a><br>
GF: Ralph Dehner / Unternehmenssitz: Vohburg / AG: Ingolstadt,HRB 3537<br>
</font></span></blockquote></span></div><span class=""><font color="#888888"><br><br clear="all"><div><br></div>-- <br><div><div dir="ltr"><div>Anne Gentle</div><div>Rackspace</div><div>Principal Engineer</div><div><a href="http://www.justwriteclick.com" target="_blank">www.justwriteclick.com</a></div></div></div>
</font></span></div></div>
</blockquote></div><br><br clear="all"><div><br></div>-- <br><div class="gmail_signature"><div dir="ltr"><div>Anne Gentle</div><div>Rackspace</div><div>Principal Engineer</div><div><a href="http://www.justwriteclick.com" target="_blank">www.justwriteclick.com</a></div></div></div>
</div></div></div>