add basic documentation; some details may be filled in or updated later
Change-Id: I7defee478ae935ef86bdb8a769adc3fcc0ac0286
Signed-off-by: pceicicd <pekwatch746@gmail.com>
diff --git a/docs/_static/logo.png b/docs/_static/logo.png
new file mode 100644
index 0000000..c3b6ce5
--- /dev/null
+++ b/docs/_static/logo.png
Binary files differ
diff --git a/docs/conf.py b/docs/conf.py
new file mode 100644
index 0000000..974c309
--- /dev/null
+++ b/docs/conf.py
@@ -0,0 +1,3 @@
+from docs_conf.conf import *
+
+linkcheck_ignore = ["http://localhost.*", "http://127.0.0.1.*", "https://gerrit.o-ran-sc.org.*"]
diff --git a/docs/conf.yaml b/docs/conf.yaml
new file mode 100644
index 0000000..f6b9ce5
--- /dev/null
+++ b/docs/conf.yaml
@@ -0,0 +1,3 @@
+---
+project_cfg: oran
+project: ric-app-lp
diff --git a/docs/developers-guide.rst b/docs/developers-guide.rst
new file mode 100755
index 0000000..7ef1f83
--- /dev/null
+++ b/docs/developers-guide.rst
@@ -0,0 +1,58 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. SPDX-License-Identifier: CC-BY-4.0
+.. Copyright (C) 2021 China Mobile Technology (USA) Inc. Intellectual Property
+
+
+Developers Guide
+=================
+
+.. contents::
+ :depth: 3
+ :local:
+
+
+Version bumping the Xapp
+------------------------
+
+When changes are made, update the version strings in:
+
+#. ``container-tag.yaml``
+#. ``docs/release-notes.rst``
+#. ``setup.py``
+#. ``xapp-descriptor/config.json``
+
+
+Testing RMR Healthcheck
+-----------------------
+The following instructions should deploy the lp container in bare docker, and allow you
+to test that the RMR healthcheck is working.
+
+::
+
+ docker build -t lp:latest -f Dockerfile .
+ docker run -d --net=host -e USE_FAKE_SDL=1 lp:latest
+ docker exec -it CONTAINER_ID /usr/local/bin/rmr_probe -h 127.0.0.1:4560
+
+
+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 according to its instructions.
+
+Upon completion, view the test coverage like this:
+
+::
+
+ tox
+ open htmlcov/index.html
+
+Alternatively, if you cannot install RMR locally, you can run the unit
+tests in Docker. This is somewhat less nice because you don't get the
+pretty HTML report on coverage.
+
+::
+
+ docker build --no-cache -f Dockerfile-Unit-Test .
diff --git a/docs/favicon.ico b/docs/favicon.ico
new file mode 100644
index 0000000..00b0fd0
--- /dev/null
+++ b/docs/favicon.ico
Binary files differ
diff --git a/docs/index.rst b/docs/index.rst
new file mode 100644
index 0000000..65c7c9f
--- /dev/null
+++ b/docs/index.rst
@@ -0,0 +1,20 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. SPDX-License-Identifier: CC-BY-4.0
+.. Copyright (C) 2021 China Mobile Technology (USA) Inc. Intellectual Property
+
+
+Welcome to O-RAN SC lp Documentation
+============================================
+
+.. toctree::
+ :maxdepth: 2
+ :caption: Contents:
+
+ overview.rst
+ release-notes.rst
+ installation-guide.rst
+ developers-guide.rst
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
diff --git a/docs/installation-guide.rst b/docs/installation-guide.rst
new file mode 100755
index 0000000..d8846ce
--- /dev/null
+++ b/docs/installation-guide.rst
@@ -0,0 +1,16 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. SPDX-License-Identifier: CC-BY-4.0
+.. Copyright (C) 2021 China Mobile Technology (USA) Inc. Intellectual Property
+
+
+Installation Guide
+==================
+
+.. contents::
+ :depth: 3
+ :local:
+
+Installation
+------------
+
+[to come]
diff --git a/docs/overview.rst b/docs/overview.rst
new file mode 100644
index 0000000..301877a
--- /dev/null
+++ b/docs/overview.rst
@@ -0,0 +1,8 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. SPDX-License-Identifier: CC-BY-4.0
+.. Copyright (C) 2021 China Mobile Technology (USA) Inc. Intellectual Property
+
+lp Overview
+==================
+
+lp accounts for "load predictor". It is an Xapp that generates load predictions that can be consumed by Traffic Steering use cases.
diff --git a/docs/release-notes.rst b/docs/release-notes.rst
new file mode 100644
index 0000000..2f2d3f0
--- /dev/null
+++ b/docs/release-notes.rst
@@ -0,0 +1,15 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. SPDX-License-Identifier: CC-BY-4.0
+.. Copyright (C) 2021 China Mobile Technology (USA) Inc. Intellectual Property
+
+Release Notes
+===============
+
+.. contents::
+ :depth: 3
+ :local:
+
+Releases
+------------
+
+[to come]
diff --git a/docs/requirements-docs.txt b/docs/requirements-docs.txt
new file mode 100644
index 0000000..09a0c1c
--- /dev/null
+++ b/docs/requirements-docs.txt
@@ -0,0 +1,5 @@
+sphinx
+sphinx-rtd-theme
+sphinxcontrib-httpdomain
+recommonmark
+lfdocs-conf
