Jump to: navigation, search


< Documentation
Revision as of 20:09, 9 April 2013 by Annegentle (talk | contribs) (Actions on Final Branch)

OpenStack continuously publishes docs from the master branch. It doesn't track with milestone releases, as there are not enough contributors to make that happen. When the number of doc bugs for a specific release seems tolerable (that is, publishing the "release" documents won't cause more questions than it answers), we follow these steps to create a stable branch that is published to a named release directory on the docs site, such as docs.openstack.org/folsom.

Here are the checklist steps for creating a release of the Documentation from the http://github.com/openstack/openstack-manuals repository.


Create a local branch that will become the stable/releasename branch. Then, do all these things to it:

Actions on Final Branch

1. Change all pom.xml files:

  • Update the <plugin><version> to the known version of the Cloud docs plugin that works with this book. For the Grizzly release, use 1.7.2. Avoid the use of SNAPSHOT in a release deliverable since it's a work-in progress untested build of the plugin.
  • Leave <release.path.name>unknown</release.path.name> or <release.path.name>local</release.path.name> alone, Jenkins fills that in. We could switch all of them to use <release.path.name>local</release.path.name> as it makes the most logical sense.

2. Change all the book files:

  • Update the URL to the PDF file so that it matches the change to the pom file to insert the release name in the PDF file name.
  • Ensure the revision history table notes the final update.
  • Ensure the book file contains the date of final publish.
  • Ensure the book file contains the correct release name and not "trunk".
  • Create a new id for the book in the metadata, so that comments from the old book aren't associated with the new release book.

3. Create a test build of each book and look at the PDF and HTML output, ensuring images are displaying properly and that the PDF and RSS links work.

4. Change the index.html files in the /www folder to point to the release name version of each deliverable.

5. Check in this final branch for review.

6. Notify the CI team of the branch that is ready for cutting as a release branch.

Continuous Integration and Automation

For Jenkins, make sure that the openstack-ci-puppet repo has the correct settings in the gerrit-doc-properties.sh file in the openstack-ci-puppet repo.

Disqus comments are turned on for the release with the ${comments.enabled} setting in the openstack-ci-puppet/modules/jenkins/files/slave_scripts/docbook-properties.sh file.

  • Ensure any incubated project now builds to /trunk.

Update Google site map and Google Custom Search Engine

This step requires the use of a Google account that administers the paid Custom Search Engine. Currently Anne Gentle and Todd Morey have these credentials.

  • Ensure that the sitemap.xml stored on the web server contains links to the latest release. Using http://www.freesitemapgenerator.com, it's an online generator tool with a 5,000 page limit.
  • Ensure that the past release site is removed from the Google Custom Search engine.