From d9efe9cac63e6916d1012e39ec0912e9693e7c52 Mon Sep 17 00:00:00 2001 From: Radosław Piliszek Date: Thu, 17 Sep 2020 18:36:47 +0200 Subject: Improve docs Part of changes discussed during Kolla Kalls. These make our documentation easier to digest. Changes in conf.py are to avoid warnings from sphinx. Change-Id: I76ab6786b271963252278fcf12f1a28cab520fdb --- doc/source/contributor/genconfig.rst | 18 ++++++++++++++ doc/source/contributor/index.rst | 2 ++ doc/source/contributor/running-in-development.rst | 29 +++++++++++++++++++++++ 3 files changed, 49 insertions(+) create mode 100644 doc/source/contributor/genconfig.rst create mode 100644 doc/source/contributor/running-in-development.rst (limited to 'doc/source/contributor') diff --git a/doc/source/contributor/genconfig.rst b/doc/source/contributor/genconfig.rst new file mode 100644 index 000000000..e026dd1e1 --- /dev/null +++ b/doc/source/contributor/genconfig.rst @@ -0,0 +1,18 @@ +=========================== +Generating kolla-build.conf +=========================== + +Install tox and generate the build configuration. The build configuration is +designed to hold advanced customizations when building images. + +If you have already cloned the Kolla Git repository to the ``kolla`` folder, +generate the ``kolla-build.conf`` file using the following steps. + +.. code-block:: console + + python3 -m pip install tox + cd kolla/ + tox -e genconfig + +The location of the generated configuration file is +``etc/kolla/kolla-build.conf``. diff --git a/doc/source/contributor/index.rst b/doc/source/contributor/index.rst index bec582049..f8725fab1 100644 --- a/doc/source/contributor/index.rst +++ b/doc/source/contributor/index.rst @@ -13,7 +13,9 @@ We welcome everyone to join our project! :maxdepth: 2 contributing + running-in-development adding-a-new-image + genconfig release-notes running-tests code-reviews diff --git a/doc/source/contributor/running-in-development.rst b/doc/source/contributor/running-in-development.rst new file mode 100644 index 000000000..4645b48ed --- /dev/null +++ b/doc/source/contributor/running-in-development.rst @@ -0,0 +1,29 @@ +.. _running-in-development: + +================================== +Running Kolla Build in development +================================== + +The recommended way to run in development +----------------------------------------- + +The preferred way to run kolla-build for development is using ``tox``. +Run the following from inside the repository: + +.. code-block:: console + + tox -e venv -- kolla-build ... + +The alternative way to run in development +----------------------------------------- + +Sometimes, developers prefer to manage their venvs themselves. This is also +possible. Remember to install in editable mode (``-e``). Run the following from +inside the repository: + +.. code-block:: console + + python3 -m venv ~/path/to/venv + source ~/path/to/venv/bin/activate + python3 -m pip install -e . + kolla-build ... -- cgit v1.2.3