From 755d5172b325fbfebb80df64a63d6faf653c3390 Mon Sep 17 00:00:00 2001
From: Steven Dake <stdake@cisco.com>
Date: Sat, 20 Aug 2016 08:24:12 -0700
Subject: [PATCH] Make tox -e docs work
There were some problems in the documentaiton that
prevented tox -e docs from working. Also changed
attention to WARNING since attention was not as eye-grabbing
as I'd hoped during a previous review.
Change-Id: I2b661afa2cd4a4331bbcc99240d3e127a5d94a11
---
doc/image-building.rst | 8 ++++----
doc/quickstart.rst | 24 +++++++++++++-----------
2 files changed, 17 insertions(+), 15 deletions(-)
diff --git a/doc/image-building.rst b/doc/image-building.rst
index bd331e1ba..1ffa60794 100644
--- a/doc/image-building.rst
+++ b/doc/image-building.rst
@@ -147,8 +147,8 @@ Kolla images.
This offers a lot of flexibility on how images are built, e.g. installing extra
packages as part of the build, tweaking settings, installing plugins, and
-numerous other capabilities. Some of these examples are described in more detail
-below.
+numerous other capabilities. Some of these examples are described in more
+detail below.
Generic Customisation
---------------------
@@ -188,8 +188,8 @@ Package Customisation
---------------------
Packages installed as part of a container build can be overridden, appended to,
-and deleted. Taking the Horizon example, the following packages are installed as
-part of a binary install type build:
+and deleted. Taking the Horizon example, the following packages are installed
+as part of a binary install type build:
* ``openstack-dashboard``
* ``httpd``
diff --git a/doc/quickstart.rst b/doc/quickstart.rst
index 730635e97..ac906a5ff 100644
--- a/doc/quickstart.rst
+++ b/doc/quickstart.rst
@@ -49,9 +49,10 @@ and OverlayFS. In order to update kernel in Ubuntu 14.04 LTS to 4.2, run:
apt-get install linux-image-generic-lts-wily
-.. attention:: Operators performing an evaluation or deployment should use a
- stable release. Operators performing development (or developers) should use
- master.
+.. WARNING::
+ Operators performing an evaluation or deployment should use a stable
+ branch. Operators performing development (or developers) should use
+ master.
.. note:: Install is *very* sensitive about version of components. Please
review carefully because default Operating System repos are likely out of
@@ -262,14 +263,15 @@ requirements it can be installed by:
apt-get install ansible
-.. attention:: Kolla uses PBR in its implementation. PBR provides version
- information to Kolla about the package in use. This information is later
- used when building images to specify the Docker tag used in the image built.
- When installing the Kolla package via pip, PBR will always use the PBR version
- information. When obtaining a copy of the software via git, PBR will use the
- git version information, but **ONLY** if Kolla has not been pip installed via
- the pip package manager. This is why there is an operator workflow and a
- developer workflow.
+.. WARNING::
+ Kolla uses PBR in its implementation. PBR provides version information
+ to Kolla about the package in use. This information is later used when
+ building images to specify the Docker tag used in the image built. When
+ installing the Kolla package via pip, PBR will always use the PBR version
+ information. When obtaining a copy of the software via git, PBR will use
+ the git version information, but **ONLY** if Kolla has not been pip
+ installed via the pip package manager. This is why there is an operator
+ workflow and a developer workflow.
Installing Kolla for evaluation or deployment
---------------------------------------------
--
GitLab