From: Laura Flores <lflores@redhat.com>
Date: Tue, 2 Nov 2021 15:40:26 +0000 (+0000)
Subject: docs: improve instructions for installing teuthology
X-Git-Tag: 1.2.0~226^2
X-Git-Url: http://git-server-git.apps.pok.os.sepia.ceph.com/?a=commitdiff_plain;h=refs%2Fpull%2F1691%2Fhead;p=teuthology.git

docs: improve instructions for installing teuthology

This only applies to the "Ubuntu, Fedora, & Suse/Opensuse" section.

Signed-off-by: Laura Flores <lflores@redhat.com>
---

diff --git a/docs/INSTALL.rst b/docs/INSTALL.rst
index 3ecff7c8d..28a96c9cd 100644
--- a/docs/INSTALL.rst
+++ b/docs/INSTALL.rst
@@ -5,12 +5,24 @@ Installation and setup
 
 Ubuntu, Fedora & SUSE/openSUSE
 ------------------------------
+First, clone the `git repository <https://github.com/ceph/teuthology/>`__::
 
-A bootstrap script is provided that will do everything for you assuming
+    git clone https://github.com/ceph/teuthology.git
+
+Next, run the bootstrap script, which will do everything for you assuming
 you have ``sudo``::
 
+    cd teuthology
     ./bootstrap
 
+Finally, activate the ``virtualenv``::
+
+    source virtualenv/bin/activate
+
+Run a teuthology command to confirm that everything's working. For instance::
+
+    teuthology --help
+
 MacOS X
 -------