Go to file

Jiri Stransky 2c7631f902 Fix environment-specific limiting for upgrade docs

We now properly tag the repository switching admonitions so that they
show up correctly with regards to the state of "Limit Environment
Specific Content" checkboxes for the "Upgrade Version" category.

This means we also have to add Kilo to Liberty upgrade tag so that
Liberty repos are properly tagged and hideable, even though Kilo to
Liberty upgrades aren't really supported. This peculiar situation will
resolve itself once we remove Liberty-specific steps from the
documentation.

Also a minor tweak is removing a TODO comment from the docs. We'll keep
tweaking the docs as we improve he upgrades experience in that regard.

Change-Id: I1f2c85d89016ce30f392fc05aa35d6796588d748

2016-08-09 14:30:39 +02:00

doc/source

Fix environment-specific limiting for upgrade docs

2016-08-09 14:30:39 +02: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

Update README files for TripleO documentation

2016-01-14 16:10:32 +00:00

requirements.txt

Initial import of TripleO docs

2015-09-01 21:14:49 -04:00

setup.cfg

Merge "remove python 2.6 trove classifier"

2016-03-22 16:45:13 +00:00

setup.py

Initial import of TripleO docs

2015-09-01 21:14:49 -04:00

test-requirements.txt

Initial import of TripleO docs

2015-09-01 21:14:49 -04:00

tox.ini

Update the tox config to build the docs by default

2016-03-21 08:49:10 +00:00

README.rst

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.