RIC-769: Committing individual files rather than tar archive

[ric-plt/appmgr.git] / xapp_orchestrater / dev / docs / index.rst

diff --git a/xapp_orchestrater/dev/docs/index.rst b/xapp_orchestrater/dev/docs/index.rst
new file mode 100644 (file)
index 0000000..d7e3537
--- /dev/null
+++ b/xapp_orchestrater/dev/docs/index.rst
@@ -0,0 +1,25 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. SPDX-License-Identifier: CC-BY-4.0
+..
+.. Copyright (C) 2019 AT&T Intellectual Property
+
+
+Welcome to O-RAN SC Integratoin for xApp Development Documentation
+==================================================================
+
+The it/dev repo is used by the O-RAN SC Integration and Testing project for hosting miscellaneous development codes.
+This repo contains integration artifacts for developing Near Realtime RAN Intelligent Controller applications (xApps).
+
+Because the life cycles of Near Realtime RIC xApps are managed by Near Realtime RIC
+Platform, the xApps are expect to conform with certain behavioral patterns and provide
+well-described interfaces.  The artifacts here help the xApp developers to generate (Near Realtime) RIC Platform deployment ready Helm charts for their xApps.
+
+
+The following is a list of projects hosted by this repo.
+
+.. toctree::
+   :maxdepth: 1
+
+   xapp_onboarder/index.rst
+   release-notes.rst
+