75c2c3c444
Even though the installing user is added to the docker group, this only takes effect after they restart their shell session. So if they install the undercloud and run prepare in the same session, the prepare call will fail at the docker operations. Rather than explain this caveat, document calling prepare with sudo. This is already done on line #266, but this change ensures every reference to the command includes sudo. Change-Id: Ia14b0964dcaefbbf7265b3960315114219fd3c7b Closes-Bug: #1793375
Team and repository tags
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.