Directory skeletion

[oam/tr069-adapter.git] / docs / overview.rst

diff --git a/docs/overview.rst b/docs/overview.rst
new file mode 100644 (file)
index 0000000..d9fba9f
--- /dev/null
+++ b/docs/overview.rst
@@ -0,0 +1,39 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. SPDX-License-Identifier: CC-BY-4.0
+.. Copyright (C) 2020 highstreet technologies and others
+
+TR069 Adapter Overview
+======================================
+
+The O-RAN SC OAM TR069 Adapter converts BBF-TR069 management interface to 
+O-RAN OAM Interface Specification (O1-interface). 
+
+The project follows the O-RAN Architecture, O-RAN OAM Architecture and OAM
+interface specification as publiched by O-RAN Working Group1. 
+
+
+Project Resources
+-----------------
+
+The source code is available from the Linux Foundation Gerrit server:
+
+    `<https://gerrit.o-ran-sc.org/r/admin/repos/oam/tr069-adapter>`_
+
+The build (CI) jobs are in the Linux Foundation Jenkins server:
+
+    `<https://jenkins.o-ran-sc.org/view/oam/>`_
+
+Issues are tracked in the Linux Foundation Jira server:
+
+    `<https://jira.o-ran-sc.org/projects/OAM/>`_
+
+Project information is available in the Linux Foundation Wiki:
+
+    `<https://wiki.o-ran-sc.org/display/OAM/TR069+Adapter>`_
+
+
+Scope
+-----
+
+The TR069 Adapter converts BBF-TR069 messages (SOAP) into O-RAN O1 interface 
+messages for NetConf/YANG and VES.