[OpenStack-docs] Questions on Service and project name conventions

Akihiro Motoki amotoki at gmail.com
Sat Apr 25 17:32:44 UTC 2015


2015-04-26 0:54 GMT+09:00 Pratap Vedula <pratapvedula at gmail.com>:
> Good morning
>
> As a new member  to the project , requesting comments or feedback from the
> group on following :
>
> 1. OpenStack dashboard or OpenStack Dashboard :
>
>
> https://wiki.openstack.org/wiki/Documentation/Conventions#Service_and_project_names
> suggests that we use horizon: OpenStack dashboard  .
>
> http://git.openstack.org/cgit/openstack/governance/tree/reference/projects.yaml
> uses the capitalized service name, service: Dashboard .  Should we  use
> OpenStack dashboard   instead of OpenStack Dashboard? .
>
> 2. do we need to update the previous release notes with new document
> conventions or do we consider them frozen ?
>
> if the answer to the above question is yes ,what  will be best approach to
> address references to quantum  : do we lower case Quantum or change
> references to quantum   to  a different set of words

Thanks for starting the thread.

Regarding the second point, the situation is a bit special.
All "quantum" keyword is used in the past release notes.
>From the historical convention in Horizon, Horizon git repo
has our release notes in the developer docs.

I see two points related to the second topic.

I am not sure we should apply the document convention to the past release notes
because they are considered as frozen. At least I can say is that the
contents of our release notes
should be consistent between OpenStack wiki and Horizon repository.
If we apply the convention to the past release notes, I think our
convention should
be applied to  "Quantum" even though it is no longer used.

Another point is whether we should replace "Quantum" with "Neutron"
in the past release notes.

Thanks,
Akihiro


>
> this is in reference to
> https://bugs.launchpad.net/horizon/+bug/1446253
> https://review.openstack.org/#/c/175045/
>
>
>
> regards
> Pratap.
>
>
>
>
> _______________________________________________
> OpenStack-docs mailing list
> OpenStack-docs at lists.openstack.org
> http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs
>



More information about the OpenStack-docs mailing list