Doug Hellmann abbd98e952 move docs for template generator into the contributor guide

Move the docs for the template generator input files to the
contributor guide. Expand the docs to explain the template variables
and the data set within the generator code.

Change-Id: I9f98c78bc4b13ea64b6cb96537e81b69267905b1
Signed-off-by: Doug Hellmann <doug@doughellmann.com>

2017-07-26 17:26:55 -04:00

2.4 KiB

Raw Blame History

Scripts overview

This section provides an overview of scripts used by the OpenStack documentation project grouped by repositories they are stored in.

openstack-doc-tools repository

autogenerate_config_docs: Generates configuration references published at https://docs.openstack.org/ocata/config-reference/.
build_environment directory (deprecated): A Vagrant environment for working with the guides.
cleanup directory: Manually cleans up documentation files.
sitemap: Generates the sitemap.xml file.
bin: Contains scripts for building documents in the openstack-manuals repository. Used inside the tox environments.

os_doc_tools directory

openstack-autohelp: A helper script run from the git repository by autogenerate_config_docs.
openstack-auto-commands: Generates the command-line interface reference published at https://docs.openstack.org/cli-reference/. A helper script to use this tool is available at bin/doc-tools-update-cli-reference.
openstack-jsoncheck: Checks JSON files. Used for the API guides.

openstack-manuals repository

Several scripts currently reside in the openstack-manuals repository. It may be beneficial to consolidate these into the openstack-doc-tools repository.

www-generator.py: Generates static, template-based HTML files for https://docs.openstack.org/. See template-generator for details.
sync-projects.sh: Synchronizes the Glossary, common files, and some translations across multiple repositories, including api-site and security-doc.
publishdocs.sh: Publishdocs job uses this script to publish documentation to https://docs.openstack.org/.

Notes

openstack-doc-tools must be released so it can be pinned in requirements files, enabling automation to work across repositories.
There are many undocumented synchronizations (automated and manual) between the various documentation repositories. These should be documented.
There are a several jobs that must be run regularly, for example, updating the sitemap.xml file and the command line configuration reference. These should be documented.
Some manual jobs should be automated. For example, the sitemap.xml file should be automatically updated by the Gerritbot.

2.4 KiB Raw Blame History