summaryrefslogtreecommitdiff
path: root/doc/source
diff options
context:
space:
mode:
authorNguyen Hai <nguyentrihai93@gmail.com>2018-03-16 01:20:54 +0900
committerNguyen Hai <nguyentrihai93@gmail.com>2018-03-16 03:32:55 +0900
commit850bd8afaf309bea16c7250923fd39b77ae2b459 (patch)
treeef3252de603b977af49cc3c60c4d3652b54873a8 /doc/source
parent814bc1a4a0cc789d190dbddf386a9c5812d791f9 (diff)
downloadkolla-850bd8afaf309bea16c7250923fd39b77ae2b459.tar.gz
kolla-850bd8afaf309bea16c7250923fd39b77ae2b459.zip
Follow the new PTI for document build
For compliance with the Project Testing Interface as described in: [1] https://governance.openstack.org/tc/reference/project-testing-interface.html [2] http://lists.openstack.org/pipermail/openstack-dev/2017-December/125710.html Change-Id: I302aced3b50b038900375e9632ca7ed136f32914
Diffstat (limited to 'doc/source')
-rw-r--r--doc/source/admin/image-building.rst14
-rw-r--r--doc/source/admin/template-override/ovs-dpdk.rst2
-rw-r--r--doc/source/contributor/CONTRIBUTING.rst6
3 files changed, 11 insertions, 11 deletions
diff --git a/doc/source/admin/image-building.rst b/doc/source/admin/image-building.rst
index d2cbc50a9..8b5581eb3 100644
--- a/doc/source/admin/image-building.rst
+++ b/doc/source/admin/image-building.rst
@@ -271,7 +271,7 @@ within the Horizon Dockerfile.
First, create a file to contain the customisations, for example:
``template-overrides.j2``. In this place the following:
-.. code-block:: none
+.. code-block:: console
{% extends parent_template %}
@@ -320,10 +320,10 @@ as part of a binary install type build:
* ``mod_ssl``
* ``gettext``
-To add a package to this list, say, ``iproute``, first create a file, for example,
-``template-overrides.j2``. In this place the following:
+To add a package to this list, say, ``iproute``, first create a file,
+for example, ``template-overrides.j2``. In this place the following:
-.. code-block:: none
+.. code-block:: console
{% extends parent_template %}
@@ -389,7 +389,7 @@ modifications to every Dockerfile.
For example, to add the ``networking-cisco`` plugin to the ``neutron_server``
image, one may want to add the following to the ``template-override`` file:
-.. code-block:: none
+.. code-block:: console
{% extends parent_template %}
@@ -451,7 +451,7 @@ structure:
The template now becomes:
-.. code-block:: none
+.. code-block:: console
{% block neutron_server_footer %}
ADD plugins-archive /
@@ -524,7 +524,7 @@ feature for binary build type.
The template now becomes:
-.. code-block:: none
+.. code-block:: console
{% block neutron_server_footer %}
ADD additions-archive /
diff --git a/doc/source/admin/template-override/ovs-dpdk.rst b/doc/source/admin/template-override/ovs-dpdk.rst
index 7660f4665..e000a80e7 100644
--- a/doc/source/admin/template-override/ovs-dpdk.rst
+++ b/doc/source/admin/template-override/ovs-dpdk.rst
@@ -17,7 +17,7 @@ ________________
In this place the ``contrib/template-override/ovs-dpdk.j2`` file:
-.. code-block:: none
+.. code-block:: console
[openvswitch-base-plugin-ovs]
type = git
diff --git a/doc/source/contributor/CONTRIBUTING.rst b/doc/source/contributor/CONTRIBUTING.rst
index d50c34462..aae2cabd1 100644
--- a/doc/source/contributor/CONTRIBUTING.rst
+++ b/doc/source/contributor/CONTRIBUTING.rst
@@ -55,8 +55,8 @@ should inherit from the provided ``openstack-base`` image, while supporting and
infrastructure services (for example, mongodb) should inherit from ``base``.
Services consisting of only one service should be placed in an image named the
-same as that service, for example, ``horizon``. Services that consist of multiple
-processes generally use a base image and child images, for example,
+same as that service, for example, ``horizon``. Services that consist of
+multiple processes generally use a base image and child images, for example,
``glance-base``, ``glance-api``, and ``glance-registry``.
Jinja2 'blocks' are employed throughout the Dockerfile's to help operators
@@ -67,7 +67,7 @@ Some of these blocks are free form however, there are a subset that should be
common to every Dockerfile. The overall structure for a multi container service
is as follows:
-.. code-block: none
+.. code-block:: console
FROM {{ namespace }}/{{ image_prefix }}openstack-base:{{ tag }}
LABEL maintainer="{{ maintainer }}" name="{{ image_name }}" build-date="{{ build_date }}"