Open Stack

On Fri, May 29, 2015 at 4:36 PM, APlimpton <aplimpton at gmail.com> wrote:

> 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.
>
> 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.
>
> 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.
>
> 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).
>
> 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.
>
> 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. :)
>

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?

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. :)

I'd ask you to activate towards lowercase and help enforce that as standard
rather than advocating for Upper Case All the Time.

Really though, I said I'd get out of the way on this one. Hope my reasoning
makes sense.
Anne


>
> Thanks,
> Amanda
>
> On Fri, May 29, 2015 at 1:37 PM, Shilla Saebi <shilla.saebi at gmail.com>
> wrote:
>
>> +1
>>
>> Sent from my iPhone
>>
>> > On May 29, 2015, at 4:22 PM, Christian Berendt <christian at berendt.io>
>> wrote:
>> >
>> >> On 05/29/2015 09:40 PM, Andreas Jaeger wrote:
>> >> We're following the current convention for some time already and I see
>> >> no reason to change, let's keep the current convention. If there're
>> >> problems, let's fix them...
>> >
>> > +1
>> >
>> > --
>> > Christian Berendt
>> > Cloud Computing Solution Architect
>> > Mail: berendt at b1-systems.de
>> >
>> > B1 Systems GmbH
>> > Osterfeldstraße 7 / 85088 Vohburg / http://www.b1-systems.de
>> > GF: Ralph Dehner / Unternehmenssitz: Vohburg / AG: Ingolstadt,HRB 3537
>> >
>> > _______________________________________________
>> > OpenStack-docs mailing list
>> > OpenStack-docs at lists.openstack.org
>> > http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs
>>
>> _______________________________________________
>> OpenStack-docs mailing list
>> OpenStack-docs at lists.openstack.org
>> http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs
>>
>
>
> _______________________________________________
> OpenStack-docs mailing list
> OpenStack-docs at lists.openstack.org
> http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs
>
>


-- 
Anne Gentle
annegentle at justwriteclick.com
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.openstack.org/pipermail/openstack-docs/attachments/20150529/3a2d9018/attachment-0001.html>