Go to file

James Slagle cd2b6f054d Update DCN docs.

Various documentation updates for DCN.

Change-Id: Ibe568f2b89428c3dc2fd093e91f572f2091c3afb
Depends-On: Iad5c932a1f469130bcf9d82277eac4fcf7ecda75

2019-10-09 09:26:29 -04:00

_custom

Merge "Modify judgment logic"

2019-09-04 20:49:11 +00:00

_templates

Unify undercloud upgrade steps

2017-10-17 15:25:38 +02:00

deploy-guide/source

Update DCN docs.

2019-10-09 09:26:29 -04:00

doc

Fix tripleo-validations documentation page URL

2019-09-23 14:06:11 +02: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

requirements.txt

PDF documentation build

2019-09-17 17:20:48 +02:00

setup.cfg

Use "modern" way of building docs

2019-08-04 16:54:30 +02:00

setup.py

Manually sync global-requirements

2017-05-19 11:41:37 +02:00

test-requirements.txt

PDF documentation build

2019-09-17 17:20:48 +02:00

tox.ini

PDF documentation build

2019-09-17 17:20:48 +02: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.