Extend user guide with southbound API details

[ric-plt/a1.git] / docs / developer-guide.rst

diff --git a/docs/developer-guide.rst b/docs/developer-guide.rst
index 97c18a2..2f2447c 100644 (file)
--- a/docs/developer-guide.rst
+++ b/docs/developer-guide.rst
@@ -1,8 +1,8 @@
 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
 .. http://creativecommons.org/licenses/by/4.0
 
-A1 Developer Guide
-==================
+Developer Guide
+===============
 
 .. contents::
    :depth: 3
@@ -11,8 +11,8 @@ A1 Developer Guide
 Tech Stack
 ----------
 
-The A1 Mediator is implemented in Python, currently 3.8, and depends on these third-party packages
-and technologies:
+The A1 Mediator is implemented in Python, currently version 3.8, and
+depends on these third-party packages and technologies:
 
 - OpenAPI3
 - Connexion
@@ -22,7 +22,8 @@ and technologies:
 Version bumping A1
 ------------------
 
-This project follows semver. When the version string changes, these files must be updated:
+This project follows semver. When the version string changes, these
+files must be updated:
 
 #. ``setup.py``
 #. ``container-tag.yaml``
@@ -31,8 +32,9 @@ This project follows semver. When the version string changes, these files must b
 #. ``a1/openapi.yaml`` But note this is an API version, not a software version; there's no need to bump on non-API changes.
 #.  And over in the ric-plt/ric-dep repo that contains the A1 Mediator helm chart, files ``values.yaml`` and ``Chart.yaml``.
 
-It's convenient to use the Python utility `bumpversion` to maintain the first three items.
-After setup (``pip install bumpversion``) you can change the patch version like this::
+It's convenient to use the Python utility `bumpversion` to maintain
+the first three items.  After setup (``pip install bumpversion``) you
+can change the patch version like this::
 
     bumpversion --verbose patch
 
@@ -40,26 +42,30 @@ Or change the minor version like this::
 
     bumpversion --verbose minor
 
-After the `bumpversion` utility has modified the files, update the release notes then commit.
+After the `bumpversion` utility has modified the files, update the
+release notes then commit.
 
 
 Version bumping RMR
 -------------------
 
-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 production usage).
+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 production usage).
 
 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.
+#. ``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
 ----------------------
 
-If you want to update the version of python; for example this was recently done to move
-from 3.7 to 3.8, update these files:
+If you want to update the version of python; for example this was
+recently done to move from 3.7 to 3.8, update these files:
 
 #. ``Dockerfile``
 #. ``Dockerfile-Unit-Test``
@@ -70,9 +76,9 @@ Unit Testing
 
 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``.
+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: