openstack
/
tripleo-docs
Code Issues Proposed changes
RETIRED, Documentation for TripleO
510 Commits 3 Branches 0 Tags 17 MiB
Go to file
Ben Nemec 1e731bd201 Stop services only on upgrade to Ocata or later 
The undercloud upgrade process is now able to stop services itself,
so there is no need for the user to do so (and they should not, in
case part of the upgrade expects the services to be running).

This moves the service stop into a stable admonition and leaves an
explanation as to why it should not be done on Pike+.

bp undercloud-upgrade

Change-Id: Ifc52866d7f22427ec41e6ac616710e3e431dffe3
 		2017-07-31 21:59:34 +00:00
_custom Clean up admonition problems 2017-07-10 14:57:43 +00:00
_templates Clean up admonition problems 2017-07-10 14:57:43 +00:00
deploy-guide/source Update docs structure 2017-07-07 20:04:52 +00:00
doc/source Stop services only on upgrade to Ocata or later 2017-07-31 21:59:34 +00:00
.gitignore Ignore both the AUTHORS and ChangeLog files 2016-03-18 09:40:52 +00:00
.gitreview Add .gitreview 2015-09-09 10:09:29 +01:00
README.rst Show team and repo badges on README 2016-11-25 14:29:00 +01:00
requirements.txt Switch to openstackdocstheme 2017-06-23 14:01:52 -04:00
setup.cfg Enable warning-is-error for docs job 2017-02-27 17:15:41 +00:00
setup.py Manually sync global-requirements 2017-05-19 11:41:37 +02:00
test-requirements.txt Update docs structure 2017-07-07 20:04:52 +00:00
tox.ini Basic structure of TripleO Deployment Guide 2017-03-27 08:00:12 -04: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.