openstack/tripleo-docs
Code Issues Proposed changes
RETIRED, Documentation for TripleO
1,219 Commits 3 Branches 0 Tags 17 MiB
c6918e5da6
Go to file
Alex Schultz c6918e5da6 Migrate install to deploy-guide 
The deployment guide is currently pointed at triplo-docs but it has been
requested that we actually publish a deployment guide. This change
extracts many of the installation doc pages and moves them into the
deploy-guide source tree.  Once the deploy-guide is published, we will
follow up to reference the deployment guide from tripleo-docs.

Change-Id: I0ebd26f014180a92c6cf4ab0929d99b2d860796f
2019-08-16 15:42:17 -06:00
_custom Update the repositories file with stein. 2019-05-15 10:31:55 +02:00
_templates Unify undercloud upgrade steps 2017-10-17 15:25:38 +02:00
deploy-guide/source Migrate install to deploy-guide 2019-08-16 15:42:17 -06:00
doc Migrate install to deploy-guide 2019-08-16 15:42:17 -06:00
.gitignore Update .gitignore 2017-08-23 16:46:44 +05:30
.gitreview OpenDev Migration Patch 2019-04-19 19:43:03 +00:00
.zuul.yaml Cleanup zuul.yaml 2018-09-22 16:25:57 +02:00
README.rst Update openstack.org to opendev.org 2019-05-14 15:35:39 +02:00
requirements.txt Use "modern" way of building docs 2019-08-04 16:54:30 +02:00
setup.cfg Use "modern" way of building docs 2019-08-04 16:54:30 +02:00
setup.py Manually sync global-requirements 2017-05-19 11:41:37 +02:00
test-requirements.txt Use "modern" way of building docs 2019-08-04 16:54:30 +02:00
tox.ini Use "modern" way of building docs 2019-08-04 16:54:30 +02:00

README.rst

Team and repository tags

image

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

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.