[install-guide-rst] Set up conditionals for distros
Add support for conditionals for the Install Guide. This uses the tags: * rdo * obs * ubuntu Note that this is changed from the spec since sphinx does not accept a "-". Also, I changed from opensuse to suse for brevity. Adds new tox target so that "tox -e install-guides" builds only the RST Install Guide. implements bp installguide-liberty Change-Id: Ibdfbc7ff294e56f52cd6f4ef59ceeb7b6af3e28a
This commit is contained in:
parent
eebd0620a3
commit
52bbdc220f
4
.gitignore
vendored
4
.gitignore
vendored
@ -7,7 +7,9 @@ target/
|
||||
/publish-docs/
|
||||
/www/output/
|
||||
/generated/
|
||||
/doc/user-guides/build-admin/
|
||||
/doc/install-guide-rst/build-rdo/
|
||||
/doc/install-guide-rst/build-obs/
|
||||
/doc/install-guide-rst/build-ubuntu/
|
||||
.doctrees
|
||||
build/
|
||||
/build-*.log.gz
|
||||
|
@ -1,6 +1,34 @@
|
||||
============================
|
||||
OpenStack Installation Guide
|
||||
============================
|
||||
.. only:: nonsense
|
||||
|
||||
.. TODO(ajaeger): Sphinx uses the first title it finds - ignoring
|
||||
the only - to create the top most title. Therefore use this
|
||||
version. This needs to be revised.
|
||||
|
||||
============================
|
||||
OpenStack Installation Guide
|
||||
============================
|
||||
|
||||
.. only:: rdo
|
||||
|
||||
=============================================================================
|
||||
OpenStack Installation Guide for Red Hat Enterprise Linux, CentOS, and Fedora
|
||||
=============================================================================
|
||||
|
||||
.. only:: obs
|
||||
|
||||
.. title: OpenStack Installation Guide for openSUSE and SUSE Linux
|
||||
Enterprise
|
||||
|
||||
===================================================================
|
||||
OpenStack Installation Guide for openSUSE and SUSE Linux Enterprise
|
||||
===================================================================
|
||||
|
||||
.. only:: ubuntu
|
||||
|
||||
=======================================
|
||||
OpenStack Installation Guide for Ubuntu
|
||||
=======================================
|
||||
|
||||
|
||||
Abstract
|
||||
~~~~~~~~
|
||||
@ -12,7 +40,27 @@ Image Service, Block Storage, Object Storage, Telemetry,
|
||||
Orchestration, and Database. You can install any of these projects
|
||||
separately and configure them stand-alone or as connected entities.
|
||||
|
||||
This guide documents the OpenStack Liberty release.
|
||||
.. only:: rdo
|
||||
|
||||
This guide shows you how to install OpenStack by using packages
|
||||
available through Fedora 21 as well as on Red Hat Enterprise Linux
|
||||
7 and its derivatives through the EPEL repository.
|
||||
|
||||
.. only:: ubuntu
|
||||
|
||||
This guide walks through an installation by using packages
|
||||
available through Ubuntu 14.04.
|
||||
|
||||
.. only:: obs
|
||||
|
||||
This guide shows you how to install OpenStack by using packages on
|
||||
openSUSE 13.2 and SUSE Linux Enterprise Server 12 through the Open
|
||||
Build Service Cloud repository.
|
||||
|
||||
Explanations of configuration options and sample configuration files
|
||||
are included.
|
||||
|
||||
This guide documents OpenStack Liberty release.
|
||||
|
||||
.. warning:: This guide is a work-in-progress and changing rapidly
|
||||
while we continue to test and enhance the guidance. Please note
|
||||
|
@ -12,7 +12,9 @@ for guide in user-guide user-guide-admin networking-guide; do
|
||||
done
|
||||
|
||||
# Draft guides
|
||||
for guide in admin-guide-cloud-rst install-guide-rst; do
|
||||
for guide in admin-guide-cloud-rst; do
|
||||
tools/build-rst.sh doc/$guide --build build \
|
||||
--target "draft/$guide"
|
||||
done
|
||||
|
||||
tools/build-install-guides-rst.sh
|
||||
|
13
tools/build-install-guides-rst.sh
Executable file
13
tools/build-install-guides-rst.sh
Executable file
@ -0,0 +1,13 @@
|
||||
#!/bin/bash -e
|
||||
|
||||
mkdir -p publish-docs
|
||||
|
||||
for distro in obs rdo ubuntu; do
|
||||
TAG="${distro}_based"
|
||||
GLOSSARY=""
|
||||
if [[ ! -e doc/common-rst/glossary.rst ]] ; then
|
||||
GLOSSARY="--glossary"
|
||||
fi
|
||||
tools/build-rst.sh doc/install-guide-rst \
|
||||
$GLOSSARY --tag $TAG --target "draft/install-guide-rst-${TAG}"
|
||||
done
|
@ -59,7 +59,7 @@ if [ "$GLOSSARY" -eq "1" ] ; then
|
||||
tools/glossary2rst.py doc/common-rst/glossary.rst
|
||||
fi
|
||||
|
||||
if [ -z "BUILD" ] ; then
|
||||
if [ -z "$BUILD" ] ; then
|
||||
if [ -z "$TAG" ] ; then
|
||||
BUILD_DIR="$DIRECTORY/build/html"
|
||||
else
|
||||
|
4
tox.ini
4
tox.ini
@ -44,6 +44,10 @@ commands =
|
||||
commands =
|
||||
{toxinidir}/tools/build-all-rst.sh
|
||||
|
||||
[testenv:install-guides]
|
||||
commands =
|
||||
{toxinidir}/tools/build-install-guides-rst.sh
|
||||
|
||||
[testenv:publishdocs]
|
||||
# Prepare all documents (except www subdir) so that they can get
|
||||
# published on docs.openstack.org with just copying publish-docs/*
|
||||
|
Loading…
x
Reference in New Issue
Block a user