launchpad-reviewers team mailing list archive

[Ines Almeida <mp+442633@xxxxxxxxxxxxxxxxxx>]

Ines Almeida has proposed merging ~ines-almeida/turnip:update-development-docs into turnip:master.

Commit message:
Add details to development docs

Requested reviews:
  Launchpad code reviewers (launchpad-reviewers)

For more details, see:
https://code.launchpad.net/~ines-almeida/turnip/+git/turnip/+merge/442633

This adds some more details for how to run turnip locally that we added as we were testing it last week
-- 
Your team Launchpad code reviewers is requested to review the proposed merge of ~ines-almeida/turnip:update-development-docs into turnip:master.

diff --git a/docs/development.rst b/docs/development.rst
index 171db17..aeb1b72 100644
--- a/docs/development.rst
+++ b/docs/development.rst
@@ -8,10 +8,27 @@ Create a bionic container (optional):
 
 .. code:: bash
 
-    lxc launch ubuntu:bionic turnip-bionic
+    lxc launch ubuntu:bionic turnip-bionic -p ${USER}
 
 (You may want to use a profile to bind-mount your home directory as well.)
 
+SSH into the new container and navigate to the turnip repo.
+
+Create a python virtual env:
+
+.. code:: bash
+
+    python3 -m venv env
+    source env/bin/activate
+
+.. note::
+    If you created a container, you may need to install python virtual env:
+
+    .. code:: bash
+
+        sudo apt-get update
+        sudo apt-get install -y python3-venv
+
 Run the following:
 
 .. code:: bash
@@ -22,6 +39,14 @@ Run the following:
         make bootstrap
         mkdir -p /var/tmp/git.launchpad.test
 
+.. note::
+    If you are running a different ubuntu version on your container (e.g. focal), you might need to run:
+
+    .. code:: bash
+
+        make clean
+        make
+
 Running
 -------