Move all options to configuration groups with descriptive names
At the moment the documentation team hand assigns descriptive groups to each of our options. This is painful and error prone.
Instead, we should move all of our options to groups (with deprecated groups or default where it makes sense), and then make sure those groups have descriptions. The docs team can then hook off of that to generate their configuration documentation.
I think the first step is to add a hacking check to warn of options not in a group.
Blueprint information
- Status:
- Complete
- Approver:
- John Garbutt
- Priority:
- Low
- Drafter:
- Michael Still
- Direction:
- Needs approval
- Assignee:
- Michael Still
- Definition:
- Approved
- Series goal:
- Accepted for icehouse
- Implementation:
-
Implemented
- Milestone target:
-
2014.1
- Started by
- Michael Still
- Completed by
- Michael Still
Related branches
Related bugs
Sprints
Whiteboard
approving and moving to I-3, since its now done --johnthetubaguy
flagmappings that docs team maintains today: https:/
Note that some of this is covered by more specific blueprints:
- docker-opts-group
- libvirt-opts-group
- powervm-opts-group
Devstack should also be updated to use the new groups so there are no issues when deprecated options are removed.
Work Items
Dependency tree
![](deptree.png)
* Blueprints in grey have been implemented.