Confusing compute extensions documentation
Affects | Status | Importance | Assigned to | Milestone | |
---|---|---|---|---|---|
OpenStack Compute (nova) |
Fix Released
|
Undecided
|
John Kennedy |
Bug Description
The Extensions subsection of the page http://
Although extension developers are using the correct template doc/source/
Also, "Summary of Changes" is at the same level in the hierarchy as "About This Extension". A single top level bullet for each extension would be more intuitive.
A suggested fix is to update the template page so that
- top line is extension name only (and make it obvious it must be edited)
- there is an "About This Extension" sub section containing existing content
- demote "Summary of Changes" so that it appears at same level as the new "About This Extension" sub-section, below the level of the name of this extension
Existing extension documentation pages would then have to be updated to make them consistent.
Changed in nova: | |
assignee: | nobody → John Kennedy (john-m-kennedy) |
status: | New → In Progress |
tags: | added: essex-rc-potential |
Changed in nova: | |
milestone: | none → 2012.1 |
Agreed, have been meaning to log a similar bug. Would love changes beyond just the template.