openstack
/
tripleo-docs
Code Issues Proposed changes
RETIRED, Documentation for TripleO
1,193 Commits 3 Branches 0 Tags 17 MiB
Go to file
Gael Chamoulaud a5f9ef9b7c TripleO documentation update for Validations 
This patch adds documentation for the new TripleO Validations CLI
features:

When listing validations:
* '--extra-vars', which allows us to pass extra vars as a Dictionary
* '--extra-vars-file', which allows to pass a json or a yaml file
  instead of a Dictionary

When running validations:
* '--parameters', which allow us to get only a list of the available
  Ansible variables for the validations
* '--create-vars_file', which allows us to create a valid json or yaml
  file containing the available variables.

Change-Id: Ifa6786de133da5129b610b8e17fba773df517214
Signed-off-by: Gael Chamoulaud <gchamoul@redhat.com>
 		2019-07-15 14:20:00 +02:00
_custom Update the repositories file with stein. 2019-05-15 10:31:55 +02:00
_templates Unify undercloud upgrade steps 2017-10-17 15:25:38 +02:00
deploy-guide/source Upgrade hacking fixed conf.py linting 2018-11-19 11:18:17 +00:00
doc TripleO documentation update for Validations 2019-07-15 14:20:00 +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 Cleanup zuul.yaml 2018-09-22 16:25:57 +02:00
README.rst Update openstack.org to opendev.org 2019-05-14 15:35:39 +02:00
requirements.txt Switch to openstackdocstheme 2017-06-23 14:01:52 -04:00
setup.cfg Change openstack-dev to openstack-discuss 2018-12-04 17:49:29 +08:00
setup.py Manually sync global-requirements 2017-05-19 11:41:37 +02:00
test-requirements.txt Sync Sphinx requirement 2019-05-29 11:50:17 +08:00
tox.ini Dynamic name version. 2019-06-05 15:16:12 +02: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.