2bc0dbe511
This patch adds documentation for CentOS compose pinning dependency work. It explains how users can create their own jobs to use compose-repos dependency to test against a CentOS compose. It also removes two deprecated dependency pipelines. Change-Id: I39091a656bef91978a2fd08e4a4a6cfcf32a4c9f Signed-off-by: Douglas Viroel <dviroel@redhat.com> |
||
---|---|---|
_custom | ||
_templates | ||
deploy-guide/source | ||
doc | ||
.gitignore | ||
.gitreview | ||
.zuul.yaml | ||
README.rst | ||
bindep.txt | ||
requirements.txt | ||
setup.cfg | ||
setup.py | ||
tox.ini |
README.rst
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 -edocs,pdf-docs,deploy-guide
Now 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.