openstack/tripleo-docs
Code Issues Proposed changes
RETIRED, Documentation for TripleO
517 Commits 3 Branches 0 Tags 17 MiB
1cac05440f
Go to file
Raoul Scarazzini 1cac05440f Add name and comment fields desc for instackenv 
This commit adds documentation for two useful fields that are supported
and really useful in baremetal, name and _comment.

Change-Id: I52cc990b8fc1efb12931fabdd8600185fc535af6
2017-08-04 06:30:20 -04: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 Add name and comment fields desc for instackenv 2017-08-04 06:30:20 -04: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.