elements README documentation environment variables should be clearer

Bug #1504632 reported by Augustina Ragwitz
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
diskimage-builder
In Progress
Medium
Jay_Clark

Bug Description

Per email discussion, element README.rst's should contain a sub section called Environment Variables 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

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

I am currently working on this as individual commits per element, and also checking reviews that touch the README files.

Changed in diskimage-builder:
assignee: nobody → Augustina Ragwitz (missaugustina)
status: New → In Progress
description: updated
Ben Nemec (bnemec)
Changed in diskimage-builder:
importance: Undecided → Medium
Revision history for this message
Augustina Ragwitz (auggy) wrote :

I'm no longer working on this, if anyone else wants to pick it up, they can feel free.

Changed in diskimage-builder:
assignee: Augustina Ragwitz (auggy) → nobody
Revision history for this message
Augustina Ragwitz (auggy) wrote :

Picking this back up!

Changed in diskimage-builder:
assignee: nobody → Augustina Ragwitz (auggy)
Revision history for this message
Augustina Ragwitz (auggy) wrote :

Sounds like other folks are interested in this work. We should put together an etherpad to track what's been done and who is working on what, as well as any notes about bugs we've filed regarding redundancies.

Revision history for this message
Jay_Clark (jay-clark) wrote :

Decided to pick this one up. I've opened up an etherpad as @auggy suggested: https://etherpad.openstack.org/p/openstack-dib-1504632

Changed in diskimage-builder:
assignee: Augustina Ragwitz (auggy) → Jay_Clark (jay-clark)
To post a comment you must log in.
This report contains Public information  
Everyone can see this information.

Other bug subscribers

Remote bug watches

Bug watches keep track of this bug in other bug trackers.