[openstack-dev] Should project name be uppercase or lowercase?

Jeremy Stanley fungi at yuggoth.org
Tue Jul 7 14:44:39 UTC 2015


On 2015-07-07 13:24:00 +0100 (+0100), Dave Walker wrote:
[...]
> I am interested to hear why the convention in documentation for it to
> be lower case.
[...]

Seems like this question comes up once for every two or three new
writers/editors who join the Docs effort. The most recent thread on
it is from last month.

http://lists.openstack.org/pipermail/openstack-docs/2015-June/006796.html

To summarize my understanding:

  1. You should just avoid using project codenames in documentation,
     in favor of official project names (e.g., use Compute rather
     than nova) whenever possible.

  2. There are concerns that capitalized use of project codenames
     makes them more likely to present a high-profile/infringing
     target for intellectual property (trademark, et cetera) claims.

-- 
Jeremy Stanley



More information about the OpenStack-dev mailing list