[OpenStack-docs] Style Question for Project Names
Steve Gordon
sgordon at redhat.com
Mon Jun 1 09:47:04 UTC 2015
----- Original Message -----
> From: "APlimpton" <aplimpton at gmail.com>
> To: "Anne Gentle" <annegentle at justwriteclick.com>
> Cc: openstack-docs at lists.openstack.org
> Sent: Monday, June 1, 2015 5:24:40 PM
> Subject: Re: [OpenStack-docs] Style Question for Project Names
>
> After reviewing the guidelines
> http://www.openstack.org/brand/openstack-trademark-policy/
> and http://www.openstack.org/brand/, I see that there is rigor protecting
> and using for the OpenStack mark ("OpenStack") and logos. Interestingly
> there is a non-working link in the second paragraph of the Trademark Policy
> page that was supposed to go to the marks themselves. Without that link
> working it's hard to say if the individual projects were listed there. This
> is also of note because the only time I saw mention of the projects, they
> were capitalized:
>
> http://www.openstack.org/brand/openstack-trademark-policy/
> The "Powered by OpenStack" Logo, shown immediately below, may be used by
> individuals, organizations, and companies that use formally released
> OpenStack Compute (Nova) code in their application or product.
>
> The Storage Powered by OpenStack Logo, shown immediately below, may be
> used by individuals, organizations, and companies that use formally
> released OpenStack Object Storage (Swift) code in their application or
> product.
> ------
>
> Having the legal policies and the majority of people using the initial
> uppercase strengthens the argument for updating the capitalization
> conventions in favor of it.
>
> Certainly the project code names are not the legal names and won't be
> trademarked but they are proper names and proper nouns. Since the
> formal/legal names for the projects are capitalized doing the same for the
> code names doesn't place any importance, it just provides consistency. A
> friend can be named Michael but go by Mike. He wouldn't go by mike.
>
> Having all mention of the project code name as lowercase does add
> simplicity but at the cost of accuracy and clarity. Simplicity can also be
> found with the proper noun is capitalized rule. It essentially boils down
> to "only the CLI is lowercase" and has the added benefit of already being
> used commonly and provides clarity to writing.
> Examples:
> The Nova team has...
> for the OpenStack Compute (code name Nova) project. Nova is the...
> To use the nova CLI...
> In the terminal type: nova --help
>
> All that said, I certainly agree that the legal/form name should be used
> when possible. Indeed the Documentation team has been doing so for years so
> there would be fairly little updating needed for many of those guides for a
> switch to an initial capitalization.
>
>
>
> Side note: Since we have a rule for sentence capitalization for headings,
> > would it be okay for me to add that to the Conventions page? I don't see
> > any mention of it.
> >
>
> >
> It's here:
> >
> https://wiki.openstack.org/wiki/Documentation/Markup_conventions#Headings
> >
> and here:
> >
> https://wiki.openstack.org/wiki/Documentation/Conventions/DocBook#Headings
> >
>
> Aha, I was thinking of it as a general convention, not tool specific.
> Thanks for the links!
>
>
> Looks like consensus is currently:
> Keep all lowercase - 3
> Use initial uppercase - 3
>
>
> Thanks,
> Amanda
I'm for keeping the convention as it is.
Thanks,
Steve
More information about the OpenStack-docs
mailing list