Jump to: navigation, search

Difference between revisions of "Documentation/Builds"

(API Complete Reference Guides (PDFs))
(Guides for end users)
Line 64: Line 64:
| Command Line Interface Reference || https://github.com/openstack/openstack-manuals/tree/master/doc/cli-reference || http://docs.openstack.org/cli-reference/content/
| Command Line Interface Reference || https://github.com/openstack/openstack-manuals/tree/master/doc/cli-reference || http://docs.openstack.org/cli-reference/content/
| Writing your First OpenStack Application || https://github.com/openstack/api-site/tree/master/ || http://developer.openstack.org

Revision as of 19:48, 26 September 2015

Documentation source and target locations

In addition to this page, the [release] and master branches of the openstack-manuals and other repositories indicate where docs are published. For example, from the stable/icehouse release branch, doc source files are published to docs.openstack.org/icehouse and from the master branch, doc source files are published to docs.openstack.org/trunk by our lovely Jenkins butlers always at the ready.

Some content is completely generated using openstack-doc-tools, such as the configuration option tables and the CLI reference information. You will see this warning in the source file: <!-- This file is automatically generated, do not edit -->

Refer to: OpenStack Doc Tools for more information on the collection of documentation tools used for content such as the auto-generation of config tables or CLI references.

Installation guides

These guides are only built from the release branches (stable/releasename) like the example above of stable/icehouse.

Document Source location Target location
Installation Guide for Debian 7.0 https://github.com/openstack/openstack-manuals/tree/master/doc/install-guide use docs-draft on review.openstack.org for interim reviews
Installation Guide for openSUSE and SUSE Linux Enterprise Server https://github.com/openstack/openstack-manuals/tree/master/doc/install-guide http://docs.openstack.org/kilo/install-guide/install/zypper/content/
Installation Guide for Red Hat Enterprise Linux, CentOS, and Fedora https://github.com/openstack/openstack-manuals/tree/master/doc/install-guide http://docs.openstack.org/kilo/install-guide/install/yum/content/
Installation Guide for Ubuntu 12.04 (LTS) https://github.com/openstack/openstack-manuals/tree/master/doc/install-guide http://docs.openstack.org/kilo/install-guide/install/apt/content/

Guides for deployers and administrators

Document Source location Target location
Architecture Design Guide https://github.com/openstack/openstack-manuals/tree/master/doc/arch-design http://docs.openstack.org/arch-design/content/
Configuration Reference https://github.com/openstack/openstack-manuals/tree/master/doc/config-reference http://docs.openstack.org/trunk/config-reference/content/
Cloud Administrator Guide https://github.com/openstack/openstack-manuals/tree/master/doc/admin-guide-cloud http://docs.openstack.org/admin-guide-cloud/content/
High Availability Guide https://github.com/openstack/ha-guide/tree/master/doc/ha-guide http://docs.openstack.org/high-availability-guide/content/index.html
Operations Guide https://github.com/openstack/operations-guide http://docs.openstack.org/trunk/openstack-ops/content/
Security Guide https://github.com/openstack/security-doc/tree/master/security-guide http://docs.openstack.org/security-guide/content
Virtual Machine Image Guide https://github.com/openstack/openstack-manuals/tree/master/doc/image-guide http://docs.openstack.org/image-guide/content/

Guides for end users

Note: The End User Guide and Admin User Guide are being migrated to RST/Sphinx. See Documentation/Migrate for more information.

Document Source location Target location
API Quick Start https://github.com/openstack/api-site/tree/master/api-quick-start http://docs.openstack.org/api/quick-start/content/
End User Guide https://github.com/openstack/openstack-manuals/tree/master/doc/user-guide http://docs.openstack.org/user-guide/content/
Admin User Guide https://github.com/openstack/openstack-manuals/tree/master/doc/user-guide-admin http://docs.openstack.org/user-guide-admin/content/
Command Line Interface Reference https://github.com/openstack/openstack-manuals/tree/master/doc/cli-reference http://docs.openstack.org/cli-reference/content/
Writing your First OpenStack Application https://github.com/openstack/api-site/tree/master/ http://developer.openstack.org

Developer guides

Each project maintains its own developer guide. We do not publish these on the docs site.

See http://docs.openstack.org/developer/openstack-projects.html.

API Complete Reference Pages (HTML)

POM file location: api-site/api-ref/pom.xml

Source file location:

  • api-site/api-ref/src/docbkx for DocBook files
  • api-site/api-ref/src/wadls/<project-name> for WADL files and code samples

Target file location: http://developer.openstack.org/api-ref.html. See the navigation bar on the left side for links to all API reference pages.

API Complete Reference Guides (PDFs)

POM file location: api-site/api-ref-guides/pom.xml

Source file location:

  • api-site/api-ref-guides/src for DocBook files for books
  • api-site/api-ref/src/docbkx for DocBook files for chapters
  • api-site/api-ref/src/wadls/<project-name> for WADL files and code samples

Target file location: http://developer.openstack.org/api-ref-guides/bk-api-ref.pdf. See the navigation bar on the left side for links to all API reference pages. On each reference page, a link for the PDF appears in the upper right corner.

Contributor guides

Generally, the docs.openstack.org/developer documentation is meant for contributors to OpenStack projects. Each project's repo has a doc/source directory where RST source files are stored. They are built automatically with Sphinx when the patch is merged. For example, see http://git.openstack.org/cgit/openstack/horizon/tree/doc/source for the horizon contributor documentation source and http://docs.openstack.org/developer/horizon/ for the built documentation.

Document Source location Target location
Python Developer Documentation https://github.com/openstack/<project>/tree/master/doc/source/, such as https://github.com/openstack/nova/tree/master/doc/source http://docs.openstack.org/developer/openstack-projects.html
Language Bindings and Python Clients https://github.com/openstack/python-<project>client/tree/master/doc/source/, such as https://github.com/openstack/python-novaclient/tree/master/doc/source http://docs.openstack.org/developer/language-bindings.html
OpenStack Project Infrastructure https://github.com/openstack-infra/config/tree/master/doc/source http://ci.openstack.org/
Tempest Testing Project https://github.com/openstack/tempest/tree/master/doc/source http://docs.openstack.org/developer/tempest/

Build jobs

The build jobs for documentation are stored in the github.com/openstack-infra/config repository. The modules/openstack_project/files/zuul/layout.yaml file and the modules/openstack_project/files/jenkins_job_builder/config/manuals-jobs.yaml or api-docs.yaml file contain the Jenkins build jobs that build to the docs.openstack.org and developer.openstack.org sites, copying built files via FTP.

The release specific books are build for the currently supported branches (havana, icehouse), development happens on the master branch. The continously released books are only build on the master branch.

Maven Plugin

The Maven Plugin is updated periodically with features we may want to incorporate in the OpenStack build process. Specifically 1.8.0 is what we use for Grizzly documentation as it contains features designed to make life easier. These changes also required some changes in pom.xml for each book. All these changes have been incorporated so this is information to describe the settings in pom.xml. A major new feature of this version of the plugin is that images are automatically handled for you. This saves two steps and adds a level of validation.

You no longer have to add a postProcess section to your pom.xml configuration to copy image files into the webhelp output directory unless you want to do a clean up step of deleting the renamed directory.

Instead, these settings tell the build where to place the built files.


The clouddocs-maven-plugin automatically detects which images you use in your document and copies them to the output directory. When you use .svg graphics, you do not have to create a .png version. Now, when you generate web help, the clouddocs-maven-plugin automatically converts the .svg to a .png file and uses it instead. You want to ensure all images have the <figure> tag and use contentwidth="6in" as an attribute on the <imageobject>. The system also checks for the availability of images before proceeding with the build, but you may still see "Figure not found" errors that you can safely ignore.

When you generate web help, by default the plugin now automatically generates a PDF and puts it in the webhelp directory, so links will no longer break to the PDF. You can also remove any pdf processing instructions from the book file itself.


To build with the latest SNAPSHOT version of the plugin, do the following:

  1. Clone the clouddocs-maven-plugin: git clone https://git.openstack.org/stackforge/clouddocs-maven-plugin
  2. cd into the repo: cd clouddocs-maven-plugin
  3. Build the plugin: mvn clean install
  4. Edit your document's pom.xml file to depend on the current snapshot version of the plugin. E.g. 1.12.1-SNAPSHOT
  5. Build the document: mvn clean generate-sources


Like other projects, the documentation projects use a number of gates that do automatic testing of patches.

The current gates are:

  • gate-openstack-manuals-tox-checklinks
  • gate-openstack-manuals-tox-checkniceness
  • gate-openstack-manuals-tox-checksyntax
  • gate-openstack-manuals-tox-checkdeletions
  • gate-openstack-manuals-tox-doc-publish-checkbuild
  • gate-openstack-manuals-tox-checklang

Checklang Gate

We only gate on manual/language combinations that are translated sufficiently. For example, in openstack-manuals this includes Japanese with the Security Guide, HA Guide and Install Guides.

  • If an import from transifex fails, creates a failure, we do not approve the import.
  • If any other patch fails, the failure might get ignored.
  • In any case of failure, a bug gets reported against the localization project (launchpad link)

If you want to manually run this check on your local workstation you can use the checklang environment (tox -e checklang). To use this environment you first have to install the xml2po utility on your local workstation. xml2po is part of the gnome-doc-utils and can be installed with yum install gnome-doc-utils (on RedHat-based distributions), or zypper install xml2po (on SUSE-based distributions).

Markdown and DocBook

When a source file is markdown, the Jenkins jobs converts it to DocBook then builds with the Maven plugin.

The basic script is:

pandoc -f markdown -t docbook -s ${FILEPATH} |  xsltproc -o - /usr/share/xml/docbook/stylesheet/docbook5/db4-upgrade.xsl - |  xmllint  --format - | sed -e "s,<article,<chapter xml:id=\"$FILENAME\"," | sed -e 's,</article>,</chapter>,' > ${DIRPATH}/$FILENAME.xml

Then, run mvn clean generate-sources on the resulting FILENAME.xml file.

Typically the best route would be to create a Jenkins slave since it'll have all the dependencies. However if you don't want to set up your own Jenkins setup, these are the packages that have to be installed on an Ubuntu server that does the doc build:

  • asciidoc
  • xsltproc
  • docbook-xml
  • docbook5-xml
  • docbook-xsl
  • sgml-data