diff --git a/doc/source/index.rst b/doc/source/index.rst index acffc07..7beb0d0 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -6,6 +6,7 @@ Table of Contents ================= .. toctree:: - :maxdepth: 3 + :maxdepth: 2 + Installing ara-server Architecture and workflows diff --git a/doc/source/installing.rst b/doc/source/installing.rst new file mode 100644 index 0000000..066f032 --- /dev/null +++ b/doc/source/installing.rst @@ -0,0 +1,18 @@ +.. _installing: + +Installing ara-server +===================== + +``ara-server`` requires a Linux distribution with python 3 in order to work. + +It is recommended to use a python `virtual environment `_ +in order to avoid conflicts with your Linux distribution python packages:: + + # Create a virtual environment + python3 -m venv ~/.ara/venv + + # Install ara-server from source + ~/.ara/venv/bin/pip install git+https://git.openstack.org/openstack/ara-server + + # or install it from PyPi + ~/.ara/venv/bin/pip install ara-server