elements README documentation environment variables should be clearer
Bug #1504632 reported by
Augustina Ragwitz
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://
Revision history for this message
| Augustina Ragwitz (auggy) wrote | #1 |
| Changed in diskimage-builder: | |
| assignee: | nobody → Augustina Ragwitz (missaugustina) |
| status: | New → In Progress |
| description: | updated |
| Changed in diskimage-builder: | |
| importance: | Undecided → Medium |
Revision history for this message
| Augustina Ragwitz (auggy) wrote | #2 |
| Changed in diskimage-builder: | |
| assignee: | Augustina Ragwitz (auggy) → nobody |
Revision history for this message
| Augustina Ragwitz (auggy) wrote | #3 |
| Changed in diskimage-builder: | |
| assignee: | nobody → Augustina Ragwitz (auggy) |
Revision history for this message
| Augustina Ragwitz (auggy) wrote | #4 |
Revision history for this message
| Jay_Clark (jay-clark) wrote | #5 |
| Changed in diskimage-builder: | |
| assignee: | Augustina Ragwitz (auggy) → Jay_Clark (jay-clark) |
To post a comment you must log in.
I am currently working on this as individual commits per element, and also checking reviews that touch the README files.