openstack/openstack-doc-tools

History

Gauvain Pocentek b3c45cd3b7 autohelp: updated to include vmware-nsx options This patch includes the vmware-nsx github repository and updates the neutron hook to import the neutron NSX options. Change-Id: I0afefd637f2b13332692c0e1a93a730b3bc11a72		2015-04-27 16:04:39 +02:00
..
requirements	autohelp: updated to include vmware-nsx options	2015-04-27 16:04:39 +02:00
test	Merge "Remove @author tags from copyright statements"	2014-10-09 05:24:38 +00:00
__init__.py	Rename autogenerate-config-docs to autogenerate_config_docs	2014-01-21 17:00:22 +01:00
autohelp-wrapper	autohelp-wrapper: reorganise project dependencies	2015-04-23 19:01:50 +02:00
autohelp.py	autohelp: lookup options in more oslo libraries	2015-04-24 12:11:58 +02:00
diff_branches.py	Capitalize project names correctly	2015-04-14 21:10:26 +02:00
extract_swift_flags.py	swift flag: handle XML in help strings	2015-04-02 15:38:55 +02:00
flow.dia	Rename autogenerate-config-docs to autogenerate_config_docs	2014-01-21 17:00:22 +01:00
hooks.py	autohelp: updated to include vmware-nsx options	2015-04-27 16:04:39 +02:00
README.rst	Update README.rst notes for Neutron project due to recent vendor decomposition.	2015-04-07 14:56:30 -07:00
requirements.txt	Update the autohelp readme	2014-08-26 08:25:07 +02:00

README.rst

autogenerate_config_docs

Automatically generate configuration tables to document OpenStack.

Using the wrapper

autohelp-wrapper is the recommended tool to generate the configuration tables. Don't bother using autohelp.py manually.

The autohelp-wrapper script installs a virtual environment and all the needed dependencies, clones or updates the projects and manuals repositories, then runs the autohelp.py script in the virtual environment.

New and updated flagmappings are generated in the openstack-manuals repository (tools/autogenerate-config-flagmappings/ directory).

The workflow is:

$ pip install -rrequirements.txt
$ ./autohelp-wrapper update
$ $EDITOR sources/openstack-manuals/tools/autogenerate-config-flagmappings/*.flagmappings
$ ./autohelp-wrapper docbook
$ # check the results in sources/openstack-manuals

This will generate the tables for all the known projects. Note for Neutron project: If the driver/plugin resides outside the Neutron repository in stackforge, then the driver/plugin has to be explicitly installed within the virtual environment to generate the configuration options.

To generate the mappings and tables for a subset of projects, use the code names as arguments:

$ ./autohelp-wrapper update cinder heat
$ # edit the mappings files
$ ./autohelp-wrapper docbook cinder heat

Creating mappings for a new project

Run the wrapper with the create subcommand:

$ ./autohelp-wrapper create zaqar

Flagmappings files

The flagmappings files use the following format:

OPTION_SECTION/OPTION_NAME group1 [group2, ...]

Groups need to be defined manually to organize the configuration tables.

The group values can only contain alphanumeric characters, _ and - (they will be used as docbook IDs).

To make the table titles more user friendly, create or edit the PROJECT.headers file in the manuals repository. Each line of this file is of the form:

GROUP A Nice Title

Working with branches

autohelp-wrapper works on the master branch by default, but you can tell it to work on another branch:

$ ./autohelp-wrapper update -b stable/icehouse

Note

The -b switch doesn't apply to the openstack-manuals repository which will be left untouched (no git branch, no git update).

Updating swift options

Swift configuration tables are generated using the extract_swift_flags.py script. This script doesn't use a mapping file, but organize the tables using the various configuration files and sections. Most of the options must be described manually at the moment.