9b5421a14f
This is a first pass at adding upgrades docs which we don't currently have. For now trying to cover version specific caveats with a single upgrades guide. We could split this out if it is preferable. For example, for Liberty-->Mitaka there is an extra step required after upgrade-init to deliver AODH at https://review.openstack.org/#/c/320150 Co-Authored-By: Marios Andreou <marios@redhat.com> Co-Authored-By: Michele Baldessari <michele@acksyn.com> Change-Id: I4af214d1dfc595ea61be40efbc0a04e44225e8b1
TripleO Documentation
This is the documentation source for the TripleO project. You can read the generated documentation at TripleO Docs.
You can find out more about TripleO at the TripleO Wiki.
Getting Started
Documentation for the TripleO project is hosted on the OpenStack
Gerrit site. You can view all open and resolved issues in the
openstack/tripleo-docs project at TripleO
Reviews.
General information about contributing to the OpenStack documentation available at OpenStack Documentation Contributor Guide
Quick Start
The following is a quick set of instructions to get you up and running by building the TripleO documentation locally. The first step is to get your Python environment configured. Information on configuring is available at Python Project Guide
Next you can generate the documentation using the following command. Be sure to run all the commands from within the recently checked out repository.
tox -edocsNow you have the documentation generated for the various available
formats from the local source. The resulting documentation will be
available within the doc/build/ directory.