[Openstack-docs] Conventions for OpenStack Networking, legacy networking

Matt Kassawara mkassawara at gmail.com
Fri Apr 18 03:55:49 UTC 2014


I think we should use "OpenStack Networking (neutron)" and "legacy
networking (nova-network)" for titles and other "first uses" ... then
simply refer to them as OpenStack Networking (or just Networking) and
legacy networking for additional instances.


On Thu, Apr 10, 2014 at 10:09 AM, Anne Gentle <anne at openstack.org> wrote:

> Hi all,
> In reviewing the Install Guide edits it's clear we need some good guidance
> for how to refer to the continuation of two types of networking for
> OpenStack.
>
> In
> https://wiki.openstack.org/wiki/Documentation/Conventions#Service_and_project_nameswe have this guidance for the service and project names. We tend to adhere
> to this pretty well.
>
> Neutron: OpenStack Networking
>
> Generally the capitalization of the project team names like swift is
> lowercase. When used as a command-line-client name, lowercase is best. When
> used for the team or project name, typically it's not necessary to
> capitalize.
>
> However we need to be explicit about how to refer to nova-network, the
> legacy networking configuration for Compute. We tend to use OpenStack
> Networking (neutron) and legacy networking  as needed. I also tend to put
> (nova-network) in parentheses so further emphasize what exactly legacy
> networking is. It's not precisely parallel, as there's no "nova-network"
> team, it's the service name.
>
> Can we add guidance to the Documentation/Conventions wiki page so that
> reviewers have a common reference? Suggestions?
>
> Thanks,
> Anne
>
> _______________________________________________
> Openstack-docs mailing list
> Openstack-docs at lists.openstack.org
> http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs
>
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.openstack.org/pipermail/openstack-docs/attachments/20140417/d72229a2/attachment-0001.html>


More information about the Openstack-docs mailing list