openstack
/
tripleo-docs
Code Issues Proposed changes
RETIRED, Documentation for TripleO
1,692 Commits 3 Branches 0 Tags 17 MiB
Go to file
OpenStack Release Bot 9296c08c94 Update TOX_CONSTRAINTS_FILE for stable/zed 
Update the URL to the upper-constraints file to point to the redirect
rule on releases.openstack.org so that anyone working on this branch
will switch to the correct upper-constraints list automatically when
the requirements repository branches.

Until the requirements repository has as stable/zed branch, tests will
continue to use the upper-constraints list on master.

Change-Id: I7524ae1dbcef1d88978370674541a777306cd598
 		2022-11-02 16:24:59 +00: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 Merge "Correct firewall configuration doc" 2022-09-15 09:01:10 +00: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 Update .gitreview for stable/zed 2022-11-02 16:24:56 +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
setup.py Cleanup py27 support and docs 2020-04-11 16:32:11 +02:00
tox.ini Update TOX_CONSTRAINTS_FILE for stable/zed 2022-11-02 16:24:59 +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.