Comment 6 for bug 1532251

Revision history for this message
Matt Kassawara (ionosphere80) wrote :

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.