openstack/tripleo-docs
Code Issues Proposed changes
RETIRED, Documentation for TripleO
875 Commits 3 Branches 0 Tags 17 MiB
fcea0d140a
Go to file
Pranali Deore fcea0d140a Correcting split-stack document 
The deployed-server-environment-output.json format generated
from the value of the DeployedServerEnvironment output of the
overcloud-baremetal stack is not a valid json format. And service
deployment command ultimately fails due to invalid json format.

Changing the output format to json and adding a jq filter to get
json format of output value.

Change-Id: I19ee30f20ce3c02a4c4d0dfb2b522818a15f629f
2018-07-20 11:52:13 +05:30
_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 Correcting split-stack document 2018-07-20 11:52:13 +05:30
.gitignore Update .gitignore 2017-08-23 16:46:44 +05:30
.gitreview Add .gitreview 2015-09-09 10:09:29 +01: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.