Documentation for TripleO
Go to file
Katarina Strenkova 09e3ef837b Replace deprecated terms
Following up on	the usage of inclusive jargon [1] and to ensure
consistency in code, there is a need to replace deprecated term
tempest_test_blacklist with a new term tempest_test_excludelist.

Additionally, term tempest_test_whitelist was replaced with a new term



Change-Id: I71f548cc607aa7c61a6c3f1ab5c9857e4906cb57
2023-08-17 09:45:41 +02:00
_custom Fix typos in doc pages 2022-09-28 20:46:32 +05:30
_templates Unify undercloud upgrade steps 2017-10-17 15:25:38 +02:00
deploy-guide/source Replace deprecated terms 2023-08-17 09:45:41 +02:00
doc Remove repeated words 2022-12-22 17:26:10 +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
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 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 Cleanup py27 support and docs 2020-04-11 16:32:11 +02:00
tox.ini Remove tox skipdist=True 2022-12-26 10:03:32 +05:30


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.