[Openstack-docs] Conventions on naming [clarifications]

Don Domingo ddomingo at redhat.com
Fri Mar 14 05:33:40 UTC 2014


Hi,

I apologize for bringing this up a bit late, seeing as the OpenStack project naming conventions have already been discussed last month:
http://lists.openstack.org/pipermail/openstack-docs/2014-February/003804.html

Anyhow, I wanted to clarify:

* Why do "Identity Service" and "Image Service" have the word "Service" as part of their names? I assume that this is the case, seeing as "Service" is initcapped? 
* Are there instances where, say, "the Compute service" is valid? Or should such instances be replaced with "the OpenStack Compute service"? And is the convention for Compute true for Block Storage, Networking, etc?

I'm asking because, specifically for "Compute", the usage is varied across the documentation:

    "the Compute service" - 54
    "the Compute Service" - 18
    "the OpenStack Compute service" - 6
    "the OpenStack Compute Service" - 2

I only checked Compute to help illustrate the situation. I haven't checked the usage stats yet for the other service names, though I'm sure we'll find similar naming variations with Networking, Block Storage, etc. I can spend time applying the correct convention, but I'd like to verify exactly what convention to follow in this regard (not just for Compute, but for all of them). 

Again, I apologize for only bringing this up now, a month after it's already been discussed. It's just that I didn't realize the extent of the naming variation until now (I've only started contributing late January 2014). 


Regards,
Don Domingo
Content Author - OpenStack
Engineering Content Services
Email: ddomingo at redhat.com
IRC: ddomingo



More information about the Openstack-docs mailing list