Blueprint-evolution-of-autogenerate-config-docs
Revision as of 08:56, 7 October 2013 by Jaegerandi (talk | contribs) (→New format for generated tables)
- Launchpad Entry: Evolve autogenerate tools
- Created: Andreas Jaeger
- Contributors:
- Planned implementation release: Icehouse
Contents
Overview
The current autogenerate tools have a couple of limitations and we need to improve the tool to handle all current uses in the manuals. We should also evaluate switching to generator.py from oslo-incubator - and enhancing that tool.
Blueprint
Current limitations and problems
- The configuration file names, and sections within them are not shown at all
- We need to be able to show the same option in different tables for shared options
- Options with the same name - but specified in different tables - will show up as duplicated entries in a table.
Using generator.py from oslo-incubator
generator.py currently handles the parsing of config options and writing of "*.conf" files, like "nova.conf" as shipped as samples in the OpenStack code repositories. Instead of writing our own tool and handling some exceptions, I propose to enhance generator.py so that it writes the tables for us.
For this we need to figure out where our config files should life.
New format for generated tables
The tables should additionally contain the section, for example [DEFAULT] and the filename, for example nova.conf.
