Inconsistency in the documentation

[Maish]

The user creation in the Neutron part of the documentation is different from that of the rest of the documentation.
The others use a syntax as follows
keystone user-create --name=nova --pass=NOVA_PASS --<email address hidden>
keystone user-role-add --user=nova --tenant=service --role=admin

For Neutron (the syntax is slightly different)

keystone user-create --name neutron --pass NEUTRON_PASS --email <email address hidden>
keystone user-role-add --user neutron --tenant service --role admin

It would be better to have a standard syntax.
-----------------------------------
Built: 2014-09-04T01:23:23 00:00
git SHA: b211fc5aab1849dcc051f45fba7fb63050e6deaf
URL: http://docs.openstack.org/icehouse/install-guide/install/apt/content/neutron-ml2-controller-node.html
source File: file:/home/jenkins/workspace/openstack-manuals-tox-doc-publishdocs/doc/install-guide/section_neutron-ml2-controller-node.xml
xml:id: neutron-ml2-controller-node

[OpenStack Infra (hudson-openstack)]

Fix proposed to branch: master
Review: https://review.openstack.org/119605

[Roger Luethi (rl-o)]

Looking at the openstack-manuals repo, the claim that "the Neutron part of the documentation is different from that of the rest of the documentation" seems dubious. There are quite a view instances of either flavor.

It might be useful do have a standard syntax (and tell users what the equally valid alternative is), but we'd have to determine first what the standard syntax is.

The cli-reference seems to prefer the variant without equal signs.

[Maish (maishsk)]

Hi Roger - in essence I agree

I am not sure if this is preferred, but from what I have glanced over the
only one that is not documented this way is Neutron, all the others,
glance, nova, swift, heat, cinder, ceilometer and trove all use the
convention with a "=" like the proposed change.

And yes the CLI documentation (for example -
http://docs.openstack.org/cli-reference/content/keystoneclient_commands.html)
have the other syntax.

It is you documentation people's call.

___________________
Maish Saidel-Keesing
My Blog <http://technodrone.blogspot.com> - @maishsk
<http://twitter.com/maishsk>

On Sun, Sep 7, 2014 at 3:09 PM, Roger Luethi <email address hidden>
wrote:

> Looking at the openstack-manuals repo, the claim that "the Neutron part
> of the documentation is different from that of the rest of the
> documentation" seems dubious. There are quite a view instances of either
> flavor.
>
> It might be useful do have a standard syntax (and tell users what the
> equally valid alternative is), but we'd have to determine first what the
> standard syntax is.
>
> The cli-reference seems to prefer the variant without equal signs.
>
> --
> You received this bug notification because you are subscribed to the bug
> report.
> https://bugs.launchpad.net/bugs/1366473
>
> Title:
> Inconsistency in the documentation
>
> Status in OpenStack Manuals:
> In Progress
>
> Bug description:
> The user creation in the Neutron part of the documentation is different
> from that of the rest of the documentation.
> The others use a syntax as follows
> keystone user-create --name=nova --pass=NOVA_PASS --email=
> <email address hidden>
> keystone user-role-add --user=nova --tenant=service --role=admin
>
> For Neutron (the syntax is slightly different)
>
> keystone user-create --name neutron --pass NEUTRON_PASS --email
> <email address hidden>
> keystone user-role-add --user neutron --tenant service --role admin
>
> It would be better to have a standard syntax.
> -----------------------------------
> Built: 2014-09-04T01:23:23 00:00
> git SHA: b211fc5aab1849dcc051f45fba7fb63050e6deaf
> URL:
> http://docs.openstack.org/icehouse/install-guide/install/apt/content/neutron-ml2-controller-node.html
> source File:
> file:/home/jenkins/workspace/openstack-manuals-tox-doc-publishdocs/doc/install-guide/section_neutron-ml2-controller-node.xml
> xml:id: neutron-ml2-controller-node
>
> To manage notifications about this bug go to:
> https://bugs.launchpad.net/openstack-manuals/+bug/1366473/+subscriptions
>

[Andreas Jaeger (jaegerandi)]

This is a duplicate of https://bugs.launchpad.net/openstack-manuals/+bug/1287890, let's mark it as such.

[OpenStack Infra (hudson-openstack)]

Change abandoned by Tom Fifield (<email address hidden>) on branch: master
Review: https://review.openstack.org/119605
Reason: Unfortunately, based on my reading, it seems the community has gone with the alternate syntax. Your work is very much appreciated, but to keep the review system clean, we should close this patch.