Conventions in Admin User Guide
Affects | Status | Importance | Assigned to | Milestone | |
---|---|---|---|---|---|
openstack-manuals |
Opinion
|
Undecided
|
Unassigned |
Bug Description
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://
$ cinder quota-update --quotaName NewValue tenantID (camel casing)
(http://
$ cinder service-disable <host> <binary> ( angle brackets)
http://
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: 689db4e7709b7bc
Source: http://
URL: http://
Changed in openstack-manuals: | |
assignee: | nobody → Ayush Garg (ayushgrg93) |
Changed in openstack-manuals: | |
assignee: | Ayush Garg (ayushgrg93) → Xing Chen (chen-xing) |
status: | New → In Progress |
Changed in openstack-manuals: | |
assignee: | Xing Chen (chen-xing) → nobody |
status: | In Progress → Opinion |
Fix proposed to branch: master /review. openstack. org/265578
Review: https:/