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

Bug #1746302 reported by Joe Weirather
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
OpenStack Identity (keystone)
Fix Released
Low
Russell Tweed

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

Changed in keystone:
importance: Undecided → Low
status: New → Confirmed
tags: added: documentation low-hanging-fruit
removed: doc
Changed in keystone:
assignee: nobody → Russell Tweed (russell-tweed)
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix proposed to keystone (master)

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

Changed in keystone:
status: Confirmed → In Progress
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix merged to keystone (master)

Reviewed: https://review.openstack.org/550884
Committed: https://git.openstack.org/cgit/openstack/keystone/commit/?id=c625aefbd77642c0c521a2d5fda02ccd30656e01
Submitter: Zuul
Branch: master

commit c625aefbd77642c0c521a2d5fda02ccd30656e01
Author: Russell Tweed <email address hidden>
Date: Thu Mar 8 16:19:50 2018 +0000

    Use different labels for user and project names

    Modify the Install Guide to use different labels for user, role, and project
    names.

    Change-Id: I14303ae708e47a8782d4ccc2a8c2ee076bc071b8
    Closes-Bug: 1746302

Changed in keystone:
status: In Progress → Fix Released
tags: added: office-hours
tags: removed: office-hours
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix included in openstack/keystone 14.0.0.0b1

This issue was fixed in the openstack/keystone 14.0.0.0b1 development milestone.

Changed in keystone:
milestone: none → rocky-1
To post a comment you must log in.
This report contains Public information  
Everyone can see this information.

Other bug subscribers

Remote bug watches

Bug watches keep track of this bug in other bug trackers.