Open Stack

Thanks Shilla -- and we appreciate you looking out for standards Akihiro. 

For the Dev docs in project repos, we have not always ben able to review patches closely. But with the addition of many projects it's important to use standards and understand the reasoning behind them.

Anne Gentle
Content Stacker
anne at openstack.org


> On Apr 22, 2015, at 5:53 PM, Shilla Saebi <shilla.saebi at gmail.com> wrote:
> 
> Hi Akihiro,
> 
> I recently just asked this question to the mailing list myself after going through the doc conventions wiki and here is the response I received:
> 
> "The thinking here is that the team names were not trademarked nor would they ever be, so there's no reason to start rules for when to capitalize and when not to. Too many rules to track. For simplicity, always lower case the team name, the configuration file names associated with the project, the folder names, the service names, and so on. Only worry about capitalization rules when absolutely necessary. It's even why we use sentence case for titles -- there aren't additional rules to learn."
> 
> I think it's best to practice what is defined on the documentation conventions wiki page which can be found here: https://wiki.openstack.org/wiki/Documentation/Conventions#Service_and_project_names
> 
> To -1 or reject things because of disagreements with written published standards adds a major stumbling block to getting things done. It's already hard enough to get things pushed through as is. New contributors only have certain standards to work from and we shouldn't make it more difficult for them to be successful at it. Thanks
> 
> Shilla
> 
>> On Wed, Apr 22, 2015 at 5:44 PM, Akihiro Motoki <amotoki at gmail.com> wrote:
>> This is the link of Horizon reviews I mentioned in the last mail.
>> https://review.openstack.org/#/q/status:open+project:openstack/horizon+branch:master+topic:bug/1446253,n,z
>> 
>> 2015-04-23 6:43 GMT+09:00 Akihiro Motoki <amotoki at gmail.com>:
>> > Hi,
>> >
>> > I have a question on the doc team convention on capitalization on project names.
>> > https://wiki.openstack.org/wiki/Documentation/Conventions#Service_and_project_names
>> >
>> > Reviews which apply this convention to Horizon developer docs
>> > are recently proposed. I would like to ask these change match
>> > the intention of the doc team.
>> >
>> > Personally I prefer the capitalized version of project names such as
>> > Nova, Glance since they are normal words which have meanings
>> > and I think capitalizing project names highlights that it is OpenStack
>> > project names.
>> > It is just my 2 cents.
>> >
>> > Thanks,
>> > Akihiro
>> 
>> _______________________________________________
>> 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
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.openstack.org/pipermail/openstack-docs/attachments/20150422/06f6bf31/attachment.html>