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

Lana Brindley openstack at lanabrindley.com
Mon Apr 27 22:27:52 UTC 2015


-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1

On 26/04/15 03:32, Akihiro Motoki wrote:
> 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.

Hi Pratap and Akhiro,

Generally speaking, we should use "Horizon dashboard" throughout the
documentation. As far as past release notes go, though, there's no point
going back to change them. Just change them in current docs going forward :)

Hope that helps,
Lana

- -- 
Lana Brindley
Technical Writer
Rackspace Cloud Builders Australia
http://lanabrindley.com
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1

iQEcBAEBAgAGBQJVPrfnAAoJELppzVb4+KUy9cAIAM3FRntRL63ZItZiUP+Lk+ZH
A1MNGBVEDNjDGi7UWj+qXV8X7ZefUrvg64DVVTjo1xM2MFrI0sBD/rRsxLvw+hpP
jDZY72QhBDfam/xNWdl791sdcaGwAezw9z04eYAdZIwUXEw4gHtEfSkCRSdVrd87
yzguNyKes7Z6rG6erOghWrw4Bggui10E1dG7mKkCn/EaiXE5GuK7bcb0L5AOcdEW
kW/BuQNVJmWSNcuj9xbn2niTyNgprFydPfNR+Zp+afqzE5UkAz1YRDdlqKUQ7Awm
nEk5DFnI1mYHsh831zQaT7Fd3o2WghEHMKevEKQSKuLR/3GNDQp2fsVl6awvo8c=
=kEds
-----END PGP SIGNATURE-----



More information about the OpenStack-docs mailing list