Open Stack

Hi Anne,

Thanks for confirming I am on the right track. I am quite willing to hunt
down and replace across the docs. Right now it is inconsistent (sometimes
on the same page) but seems to be skewing towards the capitalized version.

I can see why you are staunchly for project name removal and I have noticed
how the main website only references the functional names.

Hopefully consensus can be reached soon. :)

Thanks,

On Fri, May 29, 2015 at 7:39 AM, Anne Gentle <annegentle at justwriteclick.com>
wrote:

>
>
> On Fri, May 29, 2015 at 9:07 AM, APlimpton <aplimpton at gmail.com> wrote:
>
>> Hi All,
>>
>> I am hoping this isn't secretly a hot button issue -- in our Conventions
>> page
>> (
>> https://wiki.openstack.org/wiki/Documentation/Conventions#OpenStack.2C_not_Openstack_or_openstack)
>> it says that the capitalization of the project team names (like swift,
>> nova, heat) are lowercase. It lists the official capitalization as
>> lowercase and further spells out that "When used as a command-line-client
>> name, lowercase is best. When used for the team or project name, typically
>> it's not necessary to capitalize."
>>
>> I think that we should revise this convention so that team and project
>> names typically start with a capitalized letter. For example Cinder,
>> Neutron, Glance.
>> Reasons:
>>   * The community seems to have embraced this style choice.
>>   * This is a logical choice as it is a proper noun.
>>   * It minimizes confusion if a reference is for project name or
>> command-line interface name.
>>
>> How does the "change a convention" process work?
>>
>
> Well, you started in the right place by bringing it to the mailing list.
>
> I think that you'll have to gather consensus here, then also be willing to
> change it everywhere. That's a lot of change in openstack-manuals and other
> official documents. In the developer docs I'm sure they use the team names
> in ways we wouldn't approve.
>
> I personally strongly argue to eliminate team names to avoid confusion.
> Try hard not to ever ever use them in documentation. It's awful to have to
> look up a list of names and map to what the service actually is or does.
> The names are meaningless, chosen by random lookkups, and get changed due
> to trademarking issues, such as quantum/neutron, marconi/zaqar so far.
>
> I dislike deep diving on convention arguments so I'll stop here, but just
> wanted to let you know the process and my "feels" on this particular issue.
> :)
> Thanks,
> Anne
>
>
>> Thanks,
>> Amanda
>>
>> _______________________________________________
>> 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/b3adb059/attachment.html>