openstack/tripleo-docs
Code Issues Proposed changes
RETIRED, Documentation for TripleO
1,318 Commits 3 Branches 0 Tags 17 MiB
cabdb3e785
Go to file
Giulio Fidente cabdb3e785 Rename External* params into ExternalSwift* 
Following up on change I4634447762aad20f2c450fe4bb7f0803d13efec2 this
updates the documentation for it to use the new parameter names.

Change-Id: I5029e1e29299281c6e53c7d5342931115364d9a6
2020-04-21 09:20:37 +02:00
_custom Merge "Modify judgment logic" 2019-09-04 20:49:11 +00:00
_templates Unify undercloud upgrade steps 2017-10-17 15:25:38 +02:00
deploy-guide/source Rename External* params into ExternalSwift* 2020-04-21 09:20:37 +02:00
doc Merge "Fix link to UC install guide and mention podman" 2020-01-23 16:27:18 +00: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 Run deploy guide jobs 2019-08-21 13:41:28 +05:30
bindep.txt Add a bindep. 2019-10-04 15:57:20 +02:00
README.rst PDF documentation build 2019-09-17 17:20:48 +02:00
requirements.txt PDF documentation build 2019-09-17 17:20:48 +02:00
setup.cfg Use "modern" way of building docs 2019-08-04 16:54:30 +02:00
setup.py Manually sync global-requirements 2017-05-19 11:41:37 +02:00
test-requirements.txt PDF documentation build 2019-09-17 17:20:48 +02:00
tox.ini tox: Keeping going with docs 2019-11-03 02:37:53 +08: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,pdf-docs,deploy-guide

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.