summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDavid Rabel <rabel@b1-systems.de>2018-04-25 19:19:29 +0200
committerDavid Rabel <rabel@b1-systems.de>2018-05-03 14:32:56 +0000
commit6f441ccd1bc1226a31884e735aeb80e248189ee6 (patch)
tree9c3d910a9f953e474576fd3fd4c247b45ab80cc7
parent4ab12d271bda657ed08ef2d2adf3f5733c4f4b38 (diff)
downloadkolla-6f441ccd1bc1226a31884e735aeb80e248189ee6.tar.gz
kolla-6f441ccd1bc1226a31884e735aeb80e248189ee6.zip
Clarify how to generate kolla-build.conf in docs
image-building.rst does not mention where to find the necessary files to generate kolla-build.conf with tox. This patch clarifies that you need to check out the git repository first and also that it is technically not necessary to generate the kolla-build.conf file. Change-Id: Ifd6ed216e5086b935ca399b1613319d67424d5ae Closes-Bug: #1744453
-rw-r--r--doc/source/admin/image-building.rst7
1 files changed, 6 insertions, 1 deletions
diff --git a/doc/source/admin/image-building.rst b/doc/source/admin/image-building.rst
index 55b86fb2f..4c1c8e92b 100644
--- a/doc/source/admin/image-building.rst
+++ b/doc/source/admin/image-building.rst
@@ -20,7 +20,12 @@ Generating kolla-build.conf
Install tox and generate the build configuration. The build configuration is
designed to hold advanced customizations when building images.
-Generate the ``kolla-build.conf`` file using the following steps.
+If you have already cloned the Kolla Git repository to the ``kolla`` folder,
+generate the ``kolla-build.conf`` file using the following steps.
+
+If you don't, you can also run ``kolla-build`` without a ``kolla-build.conf``
+or with the file you find in the ``etc_examples`` folder of the Kolla pip package.
+But you should only do that for testing purposes, if at all.
.. code-block:: console