X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=docs%2Fdeveloper-guide.rst;h=d9a3a8a22d10efffe1e9fe97f2bf1ebd4685ada1;hb=refs%2Fchanges%2F36%2F3536%2F4;hp=f562c7cc199b0e2afd82ff84df4be09d4fb680c3;hpb=75d92b757580f01bacdb745c1a1afc17f8a6f913;p=ric-plt%2Fa1.git

diff --git a/docs/developer-guide.rst b/docs/developer-guide.rst
index f562c7c..d9a3a8a 100644
--- a/docs/developer-guide.rst
+++ b/docs/developer-guide.rst
@@ -37,11 +37,14 @@ This project follows semver. When changes are made, the versions are in:
 Version bumping RMR
 -------------------
 
-As of 2020/02/13, A1 (Dockerfile), Dockerfile-Unit-Test,  and all three integration test receivers use a base image from o-ran-sc.
-The rmr version is in that base image.
-When version changes are made in that image, rebuilding those 5 containers in the A1 repo will pick it up (or just A1 itself for prod usage).
+As of 2020/02/13, A1 (Dockerfile), Dockerfile-Unit-Test, and all three
+integration test receivers use an Alpine base image and install RMR
+from a base builder image.  Must update and rebuild all 5 containers
+in the A1 repo (or just A1 itself for prod usage).
 
-However, there are two items in this repo that must be kept in sync:  ``rmr-version.yaml``, which  controls what rmr gets installed for unit testing in Jenkins, and ``integration_tests/install_rmr.sh`` which is a useful script for a variety of local testing.
+In addition these items in this repo must be kept in sync:
+* ``rmr-version.yaml`` controls what rmr gets installed for unit testing in Jenkins
+* ``integration_tests/install_rmr.sh`` is a useful script for a variety of local testing.
 
 Version bumping Python
 ----------------------
@@ -57,24 +60,31 @@ If you want to update the version of python itself (ie just done from 37 to 38):
 Unit Testing
 ------------
 
-Note,  before this will work, for the first time on the machine running the tests, run ``./install_deps.sh``. This is only needed once on the machine.
-Also, this requires the python packages ``tox`` and ``pytest``.
+Running the unit tests requires the python packages ``tox`` and ``pytest``.
+
+The RMR library is also required during unit tests. If running directly from tox
+(outside a Docker container), install RMR using the script in the integration_tests
+directory: ``install_rmr.sh``.
+
+Upon completion, view the test coverage like this:
 
 ::
 
    tox
    open htmlcov/index.html
 
-Alternatively, you can run the unit tests in Docker (this is somewhat less nice because you don't get the pretty HTML)
+Alternatively, you can run the unit tests in Docker (this is somewhat
+less nice because you don't get the pretty HTML)
 
 ::
 
-   docker build  --no-cache -t a1test:latest -f Dockerfile-Unit-Test
+   docker build  --no-cache -f Dockerfile-Unit-Test .
 
 Integration testing
 -------------------
 
-This tests A1’s external API with three test receivers. This requires docker, kubernetes and helm.
+This tests A1’s external API with three test receivers. This requires
+docker, kubernetes and helm.
 
 Build all the images: