Comment 0 for bug 1504632

Revision history for this message
Augustina Ragwitz (auggy) wrote :

Per email discussion, element README.rst's should contain a sub section called Environment Vairables with a Definition List where each entry is the environment variable. Under that environment variable we should have a field list with Required, Default, Description, and optionally Example. The goal of this change is to provide users a quick way to get the information they need, rather than the current state of having to sift through inconsistent unformatted text. This is also an opportunity to audit the README content to ensure it's up to date.

See the original thread here:
http://lists.openstack.org/pipermail/openstack-dev/2015-April/060867.html