yahoo-eng-team team mailing list archive

[Joe Weirather <jweirather@xxxxxxxxx>]

Public bug reported:

This bug tracker is for errors with the documentation, use the following
as a template and remove or add fields as you see fit. Convert [ ] into
[x] to check boxes:

- [ ] This doc is inaccurate in this way: ______
- [ ] This is a doc addition request.
- [X] I have a fix to the document that I can paste below including example: input and output. 

On this page, the sample project and user share the same label "demo".
And the role is named "user". In the CLI command at the end:

$ openstack role add --project demo --user demo user

The label "demo" appears twice and the role is called "user". Although
each instance of "demo" is preceeded by an --argument that provides
/some/ context, it may cause some confusion to some readers as to what
this command is actually doing. It could be made much more clear by
using different labels for the project, role and user labels. For
example:

$ openstack role add --project myproject --user myuser myrole


-----------------------------------
Release: 12.0.1.dev7 on 2018-01-13 11:19
SHA: e851e0046fcdfd80787d8efdccdf0362fdd7b5db
Source: https://git.openstack.org/cgit/openstack/keystone/tree/doc/source/install/keystone-users-ubuntu.rst
URL: https://docs.openstack.org/keystone/pike/install/keystone-users-ubuntu.html

** Affects: keystone
     Importance: Undecided
         Status: New


** Tags: doc

-- 
You received this bug notification because you are a member of Yahoo!
Engineering Team, which is subscribed to OpenStack Identity (keystone).
https://bugs.launchpad.net/bugs/1746302

Title:
  Consider using different (eg: not the same) labels for user and
  project names.

Status in OpenStack Identity (keystone):
  New

Bug description:
  This bug tracker is for errors with the documentation, use the
  following as a template and remove or add fields as you see fit.
  Convert [ ] into [x] to check boxes:

  - [ ] This doc is inaccurate in this way: ______
  - [ ] This is a doc addition request.
  - [X] I have a fix to the document that I can paste below including example: input and output. 

  On this page, the sample project and user share the same label "demo".
  And the role is named "user". In the CLI command at the end:

  $ openstack role add --project demo --user demo user

  The label "demo" appears twice and the role is called "user". Although
  each instance of "demo" is preceeded by an --argument that provides
  /some/ context, it may cause some confusion to some readers as to what
  this command is actually doing. It could be made much more clear by
  using different labels for the project, role and user labels. For
  example:

  $ openstack role add --project myproject --user myuser myrole

  
  -----------------------------------
  Release: 12.0.1.dev7 on 2018-01-13 11:19
  SHA: e851e0046fcdfd80787d8efdccdf0362fdd7b5db
  Source: https://git.openstack.org/cgit/openstack/keystone/tree/doc/source/install/keystone-users-ubuntu.rst
  URL: https://docs.openstack.org/keystone/pike/install/keystone-users-ubuntu.html

To manage notifications about this bug go to:
https://bugs.launchpad.net/keystone/+bug/1746302/+subscriptions