launchpad-reviewers team mailing list archive

[Guruprasad <mp+448680@xxxxxxxxxxxxxxxxxx>]

Diff comments:

> diff --git a/docs/development.rst b/docs/development.rst
> index aeb1b72..150ad9a 100644
> --- a/docs/development.rst
> +++ b/docs/development.rst
> @@ -1,35 +1,56 @@
>  Development
>  ===========
>  
> +Prerequisites
> +-------------
> +
> +* LXD is installed and set up. See
> +  `<https://documentation.ubuntu.com/lxd/en/latest/getting_started/>`_
> +  for more details.
> +
> +* A working Launchpad development environment is available. See
> +  `<https://launchpad.readthedocs.io/en/latest/how-to/running.html>`_ for more
> +  details.
> +
> +* A local user on the Launchpad development instance with an SSH key added.

This prerequisite depends on https://code.launchpad.net/~lgp171188/launchpad/+git/launchpad/+merge/448673

> +  Use the ``utilities/make-lp-user`` script inside the Launchpad container
> +  to create a new user account. This script looks for SSH public keys in
> +  the home directory of the user and automatically adds them to the created
> +  account.
> +
> +
>  Setup
>  -----
>  
> -Create a bionic container (optional):
> +These instructions should work with Ubuntu 18.04 (bionic) or 20.04 (focal).
> +
> +Create a LXD container.
>  
>  .. code:: bash
>  
>      lxc launch ubuntu:bionic turnip-bionic -p ${USER}
>  
> -(You may want to use a profile to bind-mount your home directory as well.)
> +Replace ``bionic`` in the above command with ``focal`` to create a
> +``focal`` container.
> +
> +It is useful to use a LXD profile to bind-mount your home directory inside
> +this container. See the `Launchpad setup guide`_ for an example of how to
> +do this.
>  
> -SSH into the new container and navigate to the turnip repo.
> +.. _Launchpad setup guide:  https://launchpad.readthedocs.io/en/latest/how-to/running.html#create-a-lxd-container
>  
> -Create a python virtual env:
> +Log in into the new container using SSH and navigate to the turnip repo.
> +
> +Create a Python virtual environment.
>  
>  .. code:: bash
>  
> +    sudo apt update
> +    sudo apt install -y python3-venv
>      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:
> +Run the following commands to install turnip's dependencies and bootstrap it.
>  
>  .. code:: bash
>  


-- 
https://code.launchpad.net/~lgp171188/turnip/+git/turnip/+merge/448680
Your team Launchpad code reviewers is requested to review the proposed merge of ~lgp171188/turnip:revamp-development-environment-setup-docs into turnip:master.