X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=docs%2Fdeveloper-guide.rst;fp=docs%2Fdeveloper-guide.rst;h=5f29fffb32ea1b2f9d1f1444fe2fe662e1bfe3e5;hb=3985a27696d6c5857ad54ecac7f8da32ad8edfc3;hp=1af348963112fbc12aba33ef2d080010257f25ef;hpb=6c304dfab28ffd1bbe69b9ada3d11e8fbbde014b;p=pti%2Fo2.git diff --git a/docs/developer-guide.rst b/docs/developer-guide.rst index 1af3489..5f29fff 100644 --- a/docs/developer-guide.rst +++ b/docs/developer-guide.rst @@ -10,9 +10,9 @@ Developer-Guide :local: -This project implements a reference implementation for O-RAN O2 IMS and DMS to expose INF platfrom to SMO with O2 interface. +This project implements a reference implementation for O-RAN O2 IMS and DMS to expose the INF platform to SMO with the O2 interface. -To contribute on this project, you are supposed to be familiar with INF platfrom as well as O-RAN O2 interface specifications: +To contribute to this project, you are supposed to be familiar with the INF platform as well as O-RAN O2 interface specifications: - `O-RAN SC INF platfrom`_ - `O-RAN O2 interface`_ @@ -22,12 +22,12 @@ To contribute on this project, you are supposed to be familiar with INF platfrom -1. Prerequisite for build environment -------------------------------------- +1. Prerequisite for building environment +---------------------------------------- * A ubuntu 18.04 host is sufficient to build o2 projects -:: +.. code:: shell # clone code from gerrit repo $ git clone "https://gerrit.o-ran-sc.org/r/pti/o2" && (cd "o2" && mkdir -p .git/hooks && curl -Lo `git rev-parse --git-dir`/hooks/commit-msg https://gerrit.o-ran-sc.org/r/tools/hooks/commit-msg; chmod +x `git rev-parse --git-dir`/hooks/commit-msg) @@ -37,12 +37,12 @@ To contribute on this project, you are supposed to be familiar with INF platfrom $ tox -e code -1. local test with docker-compose +2. Local test with docker-compose --------------------------------- * To test with docker-compose, a docker engine is supposed to be installed as well -:: +.. code:: shell $ docker-compose build $ docker-compose up -d @@ -54,7 +54,7 @@ To contribute on this project, you are supposed to be familiar with INF platfrom * To test with INF platform, you should install INF platform first, by default you will be able to use the 'admin' user -:: +.. code:: shell $ source ./admin_openrc.sh $ export |grep OS_AUTH_URL @@ -64,6 +64,7 @@ To contribute on this project, you are supposed to be familiar with INF platfrom 4, Tear down docker containers -:: +.. code:: shell + $ docker-compose down --remove-orphans