Conventions in Admin User Guide

[Tanja Roth]

Replaceables would be much easier to identify for the readers if the notation was consistent.

For example, I have found the following notation variants of values that need to be replaced in the Admin User Guide:

 $ cinder quota-show TENANT_ID (in capitals, with an underline)
(http://docs.openstack.org/user-guide-admin/cli_cinder_quotas.html)

$ cinder quota-update --quotaName NewValue tenantID (camel casing)
(http://docs.openstack.org/user-guide-admin/cli_cinder_quotas.html)

$ cinder service-disable <host> <binary> ( angle brackets)
http://docs.openstack.org/user-guide-admin/cli_cinder_quotas.html

How about agreeing on a convention on how to mark up (or spell) values that need to be replaced by the reader and mention this convention in the convention section of all your guides?

-----------------------------------
Release: 1.0.0 on 2016-01-08 13:44
SHA: 689db4e7709b7bcdf04fd4de66e42bfd0e3ac4e6
Source: http://git.openstack.org/cgit/openstack/openstack-manuals/tree/doc/user-guide-admin/source/common/conventions.rst
URL: http://docs.openstack.org/user-guide-admin/common/conventions.html

[OpenStack Infra (hudson-openstack)]

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

[Tanja Roth (taroth)]

FYI, I just stumbled across this: https://bugs.launchpad.net/openstack-manuals/+bug/1532251/comments/6

[OpenStack Infra (hudson-openstack)]

Change abandoned by chen.xing (<email address hidden>) on branch: master
Review: https://review.openstack.org/265578