[openstack-dev] [ironic] How should ironic and related project names be written?

Loo, Ruby ruby.loo at intel.com
Tue Aug 9 16:22:05 UTC 2016

Honestly, I don't think it matters what we use in our specifications, since specifications are not public documents. Personally, in specifications, I am fine with any of the proposed because they are all understandable! IF we have to decide on something or if we want some preferred ways, then I'd suggest going with what is more 'official'. By that, I mean we could do what is suggested for documentation on docs.openstack.org, as described at [1]: "Use lowercase when you refer to project names".

Which leads us to the question you ask, what is a "project name". I think we could use the names described in the projects.yaml file [2]. So 'ironic', 'ironic-inspector', 'ironic-lib', 'ironic-python-agent'.

What do you think?


[1] http://docs.openstack.org/contributor-guide/writing-style/openstack-components.html
[2] https://github.com/openstack/governance/blob/7176a32e158d685d4552d9935982e4981bb79bf7/reference/projects.yaml#L1978

On 2016-08-01, 6:35 AM, "Sam Betts (sambetts)" <sambetts at cisco.com<mailto:sambetts at cisco.com>> wrote:

Its official OpenStack policy that project names be written in lower case, for example Ironic must always be written as ironic, however I was recently writing a spec for IPA, and was unsure how to approach writing IPAs name in full.
Discussing this with Dmitry on IRC, we decided it would be best brought to a wider audience on the ML because this affects any project that includes ironic’s name in their name.

Ironic Python Agent
ironic Python Agent
ironic python agent

I prefer a capitalised Ironic Python Agent name, because it lines up with the way we write the acronym, IPA, and makes it obvious its a name, however I’m unsure if this aligns with the OpenStack policy. If we need to lower case the whole of IPA’s name, then I prefer we refer to it using including the dashes, so that it is obviously a project name.

A couple of other projects that also use ironic in the name:

Ironic Inspector
ironic Inspector
ironic inspector

Ironic Lib
ironic Lib
ironic lib

I would like to hear some opinions on whether we should always refer to the projects as they are written if you go to git.openstack.org (with dashes) or which of the above styles we’re allowed, and prefer?


-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.openstack.org/pipermail/openstack-dev/attachments/20160809/5b08d64f/attachment.html>

More information about the OpenStack-dev mailing list