[Openstack-docs] Conventions on naming [clarifications]

Don Domingo ddomingo at redhat.com
Mon Mar 17 00:42:38 UTC 2014


I can patch out the 20 instances of "Compute Service", not a problem.
Personally, I prefer the word "service" as lowercase.

BTW, bear in mind that as I have not been with the project that long,
I've only been using the Conventions page for naming guidance:
https://wiki.openstack.org/wiki/Documentation/Conventions#Service_and_project_names

If "Compute Service" is incorrect, then why are "Identity Service" and "Image
Service" (capital "S") correct? Or, if we're adhering to TC guidance,
as Steve G mentioned before, "Identity" was endorsed, not "Identity Service".
http://git.openstack.org/cgit/openstack/governance/tree/reference/programs.yaml

Can we clarify with the TC whether we need to strictly refer to glance as
"Image Service" or if we could simply refer to it as "Image service" (small
"s")? This would make the naming consistent.

Also, as the TC document Steve G quoted does not endorse "Identity
Service", can we now revise that to "OpenStack Identity" on the
Conventions page?
 
Once we clarify the naming convention, I can start pushing patches.

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



----- Original Message -----
From: "Andreas Jaeger" <aj at suse.com>
To: "Don Domingo" <ddomingo at redhat.com>, openstack-docs at lists.openstack.org
Sent: Saturday, March 15, 2014 4:53:51 AM
Subject: Re: [Openstack-docs] Conventions on naming [clarifications]

On 03/14/2014 06:33 AM, Don Domingo wrote:
> 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? 

I guess that's historical..

> * 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?

We use "OpenStack Compute" and appreviate as "Compute"  - thus both are
valid

> 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

Do you want to send a patch for those 20 wrong settings? Would be
appreciated!

> 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). 

Whenever I review and see a wrong setting, I speak up - and others do so
as well. And there are a few that search and fix...

> 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). 

No worries, questions for clarification are always welcome.

Andreas
-- 
 Andreas Jaeger aj@{suse.com,opensuse.org} Twitter/Identica: jaegerandi
  SUSE LINUX Products GmbH, Maxfeldstr. 5, 90409 Nürnberg, Germany
   GF: Jeff Hawn,Jennifer Guild,Felix Imendörffer,HRB16746 (AG Nürnberg)
    GPG fingerprint = 93A3 365E CE47 B889 DF7F  FED1 389A 563C C272 A126


----- Original Message -----
From: "Steve Gordon" <sgordon at redhat.com>
To: "Andreas Jaeger" <aj at suse.com>
Cc: "Don Domingo" <ddomingo at redhat.com>, openstack-docs at lists.openstack.org
Sent: Saturday, March 15, 2014 5:13:13 AM
Subject: Re: [Openstack-docs] Conventions on naming [clarifications]

----- Original Message -----
> On 03/14/2014 06:33 AM, Don Domingo wrote:
> > 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?
> 
> I guess that's historical..

Yeah, it's interesting because the names endorsed by the TC are recorded here:

    http://git.openstack.org/cgit/openstack/governance/tree/reference/programs.yaml

...and while "Image Service appears to be recorded there, "Identity Service" is referred to just as "Identity". I'm not sure there is a method to the madness there :). Which programs get included in core and thus can be prefixed with OpenStack is the domain of the board.

Thanks,

Steve



More information about the Openstack-docs mailing list