Add docs folder

Change-Id: I70bb59b981e948cdc2945a00d8b67e16f6207adf
Signed-off-by: ss412g <shuky.har-noy@intl.att.com>

diff --git a/E2Manager/container-tag.yaml b/E2Manager/container-tag.yaml
index e22b9c2..a2f2ee6 100644 (file)
--- a/E2Manager/container-tag.yaml
+++ b/E2Manager/container-tag.yaml
@@ -1,4 +1,4 @@
 # The Jenkins job requires a tag to build the Docker image.
 # Global-JJB script assumes this file is in the repo root.
 ---
 # The Jenkins job requires a tag to build the Docker image.
 # Global-JJB script assumes this file is in the repo root.
 ---

-tag: 2.0.7
+tag: 2.0.7.1

diff --git a/docs/api-docs.rst b/docs/api-docs.rst
new file mode 100644 (file)
index 0000000..58c3b0c
--- /dev/null
+++ b/docs/api-docs.rst
@@ -0,0 +1,35 @@
+.. 
+..  Copyright (c) 2019 AT&T Intellectual Property.
+..  Copyright (c) 2019 Nokia.
+..
+..  Licensed under the Creative Commons Attribution 4.0 International
+..  Public License (the "License"); you may not use this file except
+..  in compliance with the License. You may obtain a copy of the License at
+..
+..    https://creativecommons.org/licenses/by/4.0/
+..
+..  Unless required by applicable law or agreed to in writing, documentation
+..  distributed under the License is distributed on an "AS IS" BASIS,
+..  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+..
+..  See the License for the specific language governing permissions and
+..  limitations under the License.
+..
+
+.. contents::
+   :depth: 3
+   :local:
+
+API-docs
+============
+
+API document can be found in \Swagger\E2Manager_API.yaml
+
+API Introduction
+---------------
+.. Please add what API a component have exposed.
+
+API Functions
+---------------
+.. Please states the API functions.
+

diff --git a/docs/developer-guides.rst b/docs/developer-guides.rst
new file mode 100644 (file)
index 0000000..3084821
--- /dev/null
+++ b/docs/developer-guides.rst
@@ -0,0 +1,33 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+
+.. contents::
+   :depth: 3
+   :local:
+
+Developer-Guides
+==============
+
+
+.. note:
+..   * This section is used to describe what a contributor needs to know in order to work on the componenta
+
+..   * this should be very technical, aimed at people who want to help develop the components
+
+..   * this should be how the component does what it does, not a requirements document of what the component should do
+
+..   * this should contain what language(s) and frameworks are used, with versions
+
+..   * this should contain how to obtain the code, where to look at work items (Jira tickets), how to get started developing
+   
+..   * This note must be removed after content has been added.
+
+
+Processes
+---------
+
+
+
+Actions
+-------
+

diff --git a/docs/installation-guides.rst b/docs/installation-guides.rst
new file mode 100644 (file)
index 0000000..92c0f2d
--- /dev/null
+++ b/docs/installation-guides.rst
@@ -0,0 +1,113 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+
+.. contents::
+   :depth: 3
+   :local:
+
+========
+Abstract
+========
+
+This document describes how to install <Component>, it's dependencies and required system resources.
+
+.. contents::
+   :depth: 3
+   :local:
+
+Version history
+---------------------
+
++--------------------+--------------------+--------------------+--------------------+
+| **Date**           | **Ver.**           | **Author**         | **Comment**        |
+|                    |                    |                    |                    |
++--------------------+--------------------+--------------------+--------------------+
+| 20XX-XX-XX         | 0.1.0              |                   | First draft        |
+|                    |                    |                    |                    |
++--------------------+--------------------+--------------------+--------------------+
+|                    | 0.1.1              |                    |                    |
+|                    |                    |                    |                    |
++--------------------+--------------------+--------------------+--------------------+
+|                    | 1.0                |                    |                    |
+|                    |                    |                    |                    |
+|                    |                    |                    |                    |
++--------------------+--------------------+--------------------+--------------------+
+
+
+Introduction
+============
+.. <INTRODUCTION TO THE SCOPE AND INTENTION OF THIS DOCUMENT AS WELL AS TO THE SYSTEM TO BE INSTALLED>
+
+.<EXAMPLE>:
+
+This document describes the supported software and hardware configurations for the reference component as well as providing guidelines on how to install and configure such reference system.
+
+The audience of this document is assumed to have good knowledge in RAN network nd Linux system.
+
+
+Preface
+=======
+.. <DESCRIBE NEEDED PREREQUISITES, PLANNING, ETC.>
+
+<EXAMPLE>:
+
+Before starting the installation of <project name>, some planning must preceed.
+
+.. note:any preperation you need before setting up sotfware and hardware 
+
+
+Hardware requirements
+=====================
+.. <PROVIDE A LIST OF MINIMUM HARDWARE REQUIREMENTS NEEDED FOR THE INSTALL>
+
+<EXAMPLE>:
+
+Following minimum hardware requirements must be met for installation of <project name>:
+
++--------------------+----------------------------------------------------+
+| **HW Aspect**      | **Requirement**                                    |
+|                    |                                                    |
++--------------------+----------------------------------------------------+
+| **# of servers**   |                                                           |
++--------------------+----------------------------------------------------+
+| **CPU**            |                                                           |
+|                    |                                                    |
++--------------------+----------------------------------------------------+
+| **RAM**            |                                                           |
+|                    |                                                    |
++--------------------+----------------------------------------------------+
+| **Disk**           |                                                           |
+|                    |                                                    |
++--------------------+----------------------------------------------------+
+| **NICs**           |                                                           |
+|                    |                                                    |
+|                    |                                                           |
+|                    |                                                    |
+|                    |                                                   |
+|                    |                                                    |
++--------------------+----------------------------------------------------+
+
+
+
+
+
+Software installation and deployment
+==========================================
+.. <DESCRIBE THE FULL PROCEDURES FOR THE INSTALLATION OF THE O-RAN COMPONENT INSTALLATION AND DEPLOYMENT>
+
+<EXAMPLE>:
+
+This section describes the installation of the <project name> installation on the reference hardware.
+
+
+
+References
+==========
+.. <PROVIDE NEEDED/USEFUL REFERENCES>
+
+<EXAMPLES>:
+
+OpenStack
+^^^^^^^^^^^
+
+

diff --git a/docs/release-notes.rst b/docs/release-notes.rst
new file mode 100644 (file)
index 0000000..b0d6530
--- /dev/null
+++ b/docs/release-notes.rst
@@ -0,0 +1,165 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+
+
+This document provides the release notes for <RELEASE> of <COMPONENT>.
+
+.. contents::
+   :depth: 3
+   :local:
+
+
+Version history
+---------------
+
++--------------------+--------------------+--------------------+--------------------+
+| **Date**           | **Ver.**           | **Author**         | **Comment**        |
+|                    |                    |                    |                    |
++--------------------+--------------------+--------------------+--------------------+
+| 20XX-XX-XX         | 0.1.0              |                    | First draft        |
+|                    |                    |                    |                    |
++--------------------+--------------------+--------------------+--------------------+
+|                    | 0.1.1              |                    |                    |
+|                    |                    |                    |                    |
++--------------------+--------------------+--------------------+--------------------+
+|                    | 1.0                |                    |                    |
+|                    |                    |                    |                    |
++--------------------+--------------------+--------------------+--------------------+
+
+
+Summary
+=======
+
+<SUMMARIZE THE RELEASE - THE CONTENT - AND OTHER IMPORTANT HIGH LEVEL PROPERTIES>
+
+
+
+
+Release Data
+============
+<STATE RELEVANT RELEASE DATA/RECORDS>
+
+<EXAMPLE>:
+
++--------------------------------------+--------------------------------------+
+| **Project**                          | E.g. Arno/genesis/fuel@opnfv         |
+|                                      |                                      |
++--------------------------------------+--------------------------------------+
+| **Repo/commit-ID**                   | E.g. genesis/adf634a0d4.....         |
+|                                      |                                      |
++--------------------------------------+--------------------------------------+
+| **Release designation**              | E.g. Arno RC2                        |
+|                                      |                                      |
++--------------------------------------+--------------------------------------+
+| **Release date**                     | E.g. 2015-04-16                      |
+|                                      |                                      |
++--------------------------------------+--------------------------------------+
+| **Purpose of the delivery**          | E.g. OPNFV Internal quality assurance|
+|                                      |                                      |
++--------------------------------------+--------------------------------------+
+
+
+
+
+Feature additions
+~~~~~~~~~~~~~~~~~~~~~~~
+<STATE ADDED FEATURES BY REFERENCE TO JIRA>
+
+<EXAMPLE>:
+
+**JIRA BACK-LOG:**
+
++--------------------------------------+--------------------------------------+
+| **JIRA REFERENCE**                   | **SLOGAN**                           |
+|                                      |                                      |
++--------------------------------------+--------------------------------------+
+|                                     |                                      |
+|                                      |                                     |
+|                                      |                                      |
++--------------------------------------+--------------------------------------+
+|                                     |                                      |
+|                                      |                                     |
+|                                      |                                      |
++--------------------------------------+--------------------------------------+
+
+Bug corrections
+~~~~~~~~~~~~~~~~~~~~~
+
+**JIRA TICKETS:**
+
++--------------------------------------+--------------------------------------+
+| **JIRA REFERENCE**                   | **SLOGAN**                           |
+|                                      |                                      |
++--------------------------------------+--------------------------------------+
+|                                     |                                      |
+|                                      |                                     |
+|                                      |                                      |
++--------------------------------------+--------------------------------------+
+|                                     |                                      |
+|                                      |                                     |
+|                                      |                                      |
++--------------------------------------+--------------------------------------+
+
+Deliverables
+----------------
+
+Software deliverables
+^^^^^^^^^^^^^^^^^^^^^^^
+
+<STATE WHAT SOFTWARE DELIVERABLES THAT ARE RELATED TO THIS VERSION, AND WHERE THOSE CAN BE RETRIEVED>
+
+<EXAMPLE>:
+
+Documentation deliverables
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+<STATE WHAT DOCUMENTATION DELIVERABLES THAT ARE RELATED TO THIS VERSION, AND WHERE THOSE CAN BE RETRIEVED>
+
+<EXAMPLE>:
+
+
+Known Limitations, Issues and Workarounds
+=========================================
+
+System Limitations
+^^^^^^^^^^^^^^^^^^^^
+<STATE ALL RELEVANT SYSTEM LIMITATIONS, IF THERE IS ANY>
+
+
+
+Known issues
+^^^^^^^^^^^^^^^
+<STATE ALL KNOWN ISSUES WITH JIRA REFERENCE>
+
+<EXAMPLE>:
+
+**JIRA TICKETS:**
+
++--------------------------------------+--------------------------------------+
+| **JIRA REFERENCE**                   | **SLOGAN**                           |
+|                                      |                                      |
++--------------------------------------+--------------------------------------+
+|                                     |                                      |
+|                                      |                                     |
+|                                      |                                      |
++--------------------------------------+--------------------------------------+
+|                                     |                                      |
+|                                      |                                     |
+|                                      |                                      |
++--------------------------------------+--------------------------------------+
+
+Workarounds
+^^^^^^^^^^^^^^^^^
+
+<STATE ALL KNOWN WORKAROUNDS TO THE ISSUES STATED ABOVE, IF THERE IS ANY>
+
+
+
+
+References
+==========
+<STATE RELEVANT REFERENCES FOR THIS RELEASE/VERSION>
+
+
+
+