Replace with variable name?

In my opinion It should be 'tenantID' not '$tenant', as commands in step 4 and 5 are generalized command. '$tenant' is present in the example of step 4 that is correct.

Can we make this bug invalid, as per the description in comment #1.

Not sure who you are asking (there does not seem to be a "needinfo" flag in launchpad...).

You are right in saying that the commands in step 4 and 5 are generalized commands. However, it still seems a bit confusing to me to introduce a variable in step 3 and then not use it for the rest of the procedure (apart from the example in step4)...

Launchpad uses "incomplete" if a bug needs more information.

I think #3 and #4 specified above should be reorganized as follows. From example it will give an idea about how user can get the tenant id.
---------------
3. To update Block Storage service quotas
   cinder quota-update --quotaName newValue tenantID

  For example:
    $tenant=$(openstack project show -f value -c id tenant01)
    $ cinder quota-update --volumes 15 $tenant
    $ cinder quota-show tenant01
    +-----------+-------+
    | Property | Value |
    +-----------+-------+
    | gigabytes | 1000 |
    | snapshots | 10 |
    | volumes | 15 |
   +-----------+-------+

--------------------------

Other thing I would change is use consistent naming - like tenant_NAME rather than TENANT_NAME or tenant_name, same for tenantID.

Also, in the section on 'remove a service', it encloses the parameters in '<>'

Disable the service.

$ cinder service-disable <host> <binary>

I propose we change that to :

Disable the service.

$ cinder service-disable host binary

Please let me know if that will be acceptable

We use capital letters for variables (items) that require replacement, usually following them with a note explaining what to use in place of the variable. For example:

Replace VARIABLE_ITEM with ...

Some real examples:

http://docs.openstack.org/liberty/install-guide-ubuntu/keystone-install.html
http://docs.openstack.org/liberty/networking-guide/scenario_legacy_ovs.html

All of the documentation should follow this convention.

When an example requires knowledge of another action (such as obtaining a project/tenant ID), it should reference one place in the documentation to find that knowledge rather than duplicating it. Content duplication quickly becomes difficult to manage. For example, what happens if the command to determine a project/tenant ID changes? Easier to change in one place than many.

Thanks, Matt! (Also for letting me know about the "incomplete" status - did not know about that).

P Ingle's proposal of reorganizing #3 and #4 look good to me (https://bugs.launchpad.net/openstack-manuals/+bug/1532251/comments/5).

Regarding the consistency of VARIABLE_ITEMS I also filed https://bugs.launchpad.net/openstack-manuals/+bug/1532244.
From Matt's answer I now learned that there already is a convention (excellent!).
Maybe it would be easier (for the contributors) to follow this convention if you "officially" mention it in the "Conventions" section of all books (because then it simply becomes more visible).

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

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

Change abandoned by Priya Ingle (<email address hidden>) on branch: master
Review: https://review.openstack.org/269819
Reason: another change submitted - 269878

Reviewed: https://review.openstack.org/269878
Committed: https://git.openstack.org/cgit/openstack/openstack-manuals/commit/?id=0adb876756b7c5edc3b18a639b4a39fd7d8d198c
Submitter: Jenkins
Branch: master

commit 0adb876756b7c5edc3b18a639b4a39fd7d8d198c
Author: pingle <email address hidden>
Date: Tue Jan 19 12:54:50 2016 -0600

    Makes consistent use of variable in the user admin guide.

    Closes-Bug: 1532251
    Change-Id: I3e96be3fbc49463ed7d1bd5820a877b51a691c2d

This issue was fixed in the openstack/openstack-manuals 15.0.0 release.