RETIRED, Documentation for TripleO

Go to file

Brendan Shephard 9bc4ab7bf8 Node scaling now covered by baremetal_provision Node scaling with ephemeral Heat no longer works this way. Instead users should follow the baremetal_provision guide on node scaling: https://docs.openstack.org/project-deploy-guide/tripleo-docs/latest/provisioning/baremetal_provision.html#scaling-the-overcloud Change-Id: I7420904aef6e3ebf74a36f8a3c420482cde1b2d9		2022-11-02 19:22:24 +10: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	Node scaling now covered by baremetal_provision	2022-11-02 19:22:24 +10:00
doc	Add ovb bug tag	2022-10-20 15:51:23 +05:30
.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	setup.cfg: Replace dashes with underscores	2021-04-27 16:22:53 +08:00
setup.py	Cleanup py27 support and docs	2020-04-11 16:32:11 +02:00
tox.ini	Update tox.ini for tripleo-docs	2021-05-04 10:51:19 -04:00

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.