diff options
| author | Sven Kieske <kieske@osism.tech> | 2024-06-17 11:42:05 +0200 |
|---|---|---|
| committer | Sven Kieske <kieske@osism.tech> | 2024-06-21 10:45:33 +0200 |
| commit | bdf5dae433e87347a22e0a4a447640259b72d80e (patch) | |
| tree | 0af0e82c4fca56f46ff5bba9e6ecb7f61b2d6fdd /doc/source/contributor | |
| parent | 428f37124986019bedc897469f9b1f3470b62082 (diff) | |
| download | kolla-bdf5dae433e87347a22e0a4a447640259b72d80e.tar.gz kolla-bdf5dae433e87347a22e0a4a447640259b72d80e.zip | |
[docs] remove not working dev setup
also add the command to clone the repository
and use the pip-install `--editable` option in
it's long form so it's immediately clear what it does.
Change-Id: I00403f967c06af6d8c718ed1245aaa01f1218add
Signed-off-by: Sven Kieske <kieske@osism.tech>
Diffstat (limited to 'doc/source/contributor')
| -rw-r--r-- | doc/source/contributor/running-in-development.rst | 18 |
1 files changed, 5 insertions, 13 deletions
diff --git a/doc/source/contributor/running-in-development.rst b/doc/source/contributor/running-in-development.rst index 4645b48ed..ba4bc4a7b 100644 --- a/doc/source/contributor/running-in-development.rst +++ b/doc/source/contributor/running-in-development.rst @@ -7,23 +7,15 @@ 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: +To clone the repository and install the package +in development mode, run the following commands: -.. 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 + git clone https://opendev.org/openstack/kolla.git + cd kolla python3 -m venv ~/path/to/venv source ~/path/to/venv/bin/activate - python3 -m pip install -e . + python3 -m pip install --editable . kolla-build ... |