openstack/tripleo-docs
Code Issues Proposed changes
RETIRED, Documentation for TripleO
1,507 Commits 3 Branches 0 Tags 17 MiB
e484fa1349
Go to file
John Fulton e484fa1349 Update Derived Parameters doc for new name 
Related-Bug: #1926762
Depends-On: Icea13df0c48028013a7f6e45eabdb5d17cecb1ec
Change-Id: I2dfe3a97625584fadbd4b331ca1e39a4a118f3e7
2021-04-30 08:04:16 -04: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 Update Derived Parameters doc for new name 2021-04-30 08:04:16 -04:00
doc Add some docs for pre_deploy_step_tasks 2021-04-02 18:53:24 +02:00
.gitignore Update 3rd party container build with new tooling 2020-06-05 19:58:30 +00:00
.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
bindep.txt Add a bindep. 2019-10-04 15:57:20 +02:00
README.rst PDF documentation build 2019-09-17 17:20:48 +02:00
requirements.txt Switch to newer openstackdocstheme and reno versions 2020-05-28 14:42:29 +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 Merge "Remove install unnecessary packages" 2020-09-25 14:34:09 +00: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.