Automatically Generate Configuration Tables

Registered by Tom Fifield on 2013-02-19

Currently, tables of configuration options in the manuals are written and updated manually. Given in most cases these are verbatim from the code, develop a system to automatically create the tables based on the code, and keep them up to date.

This will ensure the configuration option references are always up-to-date with what is in the code and reduce effort required by the limited members of the documentation team.

Documentation changes to textual descriptions for configuration variables should then be made in the respective code project, which also improves the quality of the CLI descriptions.

Blueprint information

Status:
Complete
Approver:
Tom Fifield
Priority:
Essential
Drafter:
Tom Fifield
Direction:
Approved
Assignee:
Tom Fifield
Definition:
Approved
Series goal:
Accepted for havana
Implementation:
Implemented
Milestone target:
milestone icon havana
Started by
Tom Fifield on 2013-03-04
Completed by
Tom Fifield on 2013-08-10

Related branches

Sprints

Whiteboard

https://github.com/fifieldt/autogenerate-config-docs

Gerrit topic: https://review.openstack.org/#q,topic:bp/autogenerate-config-tables,n,z

Addressed by: https://review.openstack.org/28904
    Add nova configuration reference tables

Addressed by: https://review.openstack.org/28905
    Add quantum configuration reference tables

Addressed by: https://review.openstack.org/31731
    Add nova configuration reference tables

Addressed by: https://review.openstack.org/35726
    Add Autogenerate-config-doc code to tools

(?)

Work Items

This blueprint contains Public information 
Everyone can see this information.