openstack/tripleo-docs
Code Issues Proposed changes
RETIRED, Documentation for TripleO
919 Commits 3 Branches 0 Tags 17 MiB
cbac0f013c
Go to file
James Slagle cbac0f013c config-download User's Guide 
Adds a full User's Guide for config-download, documenting most
everything I could think of that would be useful.

Previously the page was under the "Feature Configuration" section, and
it's now moved to it's own top level section witin the ToC.

There are a few other minor fixes and improvements included.

Change-Id: I9bc2df4f44ac4ccea565d632d0072c2c4d7b3a43
2018-09-06 17:31:31 -04:00
_custom Update docs for deploying Queens 2018-03-08 12:39:31 -07:00
_templates Unify undercloud upgrade steps 2017-10-17 15:25:38 +02:00
deploy-guide/source Update docs structure 2017-07-07 20:04:52 +00:00
doc/source config-download User's Guide 2018-09-06 17:31:31 -04:00
.gitignore Update .gitignore 2017-08-23 16:46:44 +05:30
.gitreview Add .gitreview 2015-09-09 10:09:29 +01:00
.zuul.yaml import zuul job settings from project-config 2018-08-24 04:59:13 +00:00
README.rst Replace the old links in docs 2018-02-27 01:23:16 -08:00
requirements.txt Switch to openstackdocstheme 2017-06-23 14:01:52 -04:00
setup.cfg Replace the old links in docs 2018-02-27 01:23:16 -08:00
setup.py Manually sync global-requirements 2017-05-19 11:41:37 +02:00
test-requirements.txt Drop duplicate openstackdocstheme requirement 2018-01-29 13:50:47 -05:00
tox.ini fix tox python3 overrides 2018-07-16 07:47:47 +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

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.