RETIRED, Documentation for TripleO
Go to file
Lance Bragstad e99368f6c9 Introduce new TLS-e guide
This commit lays down the steps you need to take to deploy TLS-e with
TripleO. This is needed because we recently replaced novajoin with
tripleo-ipa which changes how people deploy TLS-everywhere.

Subsequent patches will:

  - introduce a guide for public TLS
  - remove legacy ssl documentation

Change-Id: I81f6a3ed542aa59c99ab57a5f2454e85ae7fde57
2020-08-04 10:56:21 -05:00
_custom Introduce new TLS-e guide 2020-08-04 10:56:21 -05:00
_templates Unify undercloud upgrade steps 2017-10-17 15:25:38 +02:00
deploy-guide/source Introduce new TLS-e guide 2020-08-04 10:56:21 -05:00
doc Merge "update list of TripleO core teams" 2020-05-12 12:11:17 +00: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 Run deploy guide jobs 2019-08-21 13:41:28 +05:30
README.rst PDF documentation build 2019-09-17 17:20:48 +02:00
bindep.txt Add a bindep. 2019-10-04 15:57:20 +02:00
requirements.txt Cleanup py27 support and docs 2020-04-11 16:32:11 +02:00
setup.cfg Cleanup py27 support and docs 2020-04-11 16:32:11 +02:00
setup.py Cleanup py27 support and docs 2020-04-11 16:32:11 +02:00
tox.ini Cleanup py27 support and docs 2020-04-11 16:32:11 +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,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.