From 90dabe77526505ba05df6f57049ffca19a3b3bd9 Mon Sep 17 00:00:00 2001 From: ss412g Date: Thu, 31 Oct 2019 14:15:11 +0200 Subject: [PATCH] Add docs folder Change-Id: I70bb59b981e948cdc2945a00d8b67e16f6207adf Signed-off-by: ss412g --- E2Manager/container-tag.yaml | 2 +- docs/api-docs.rst | 35 +++++++++ docs/developer-guides.rst | 33 +++++++++ docs/installation-guides.rst | 113 +++++++++++++++++++++++++++++ docs/release-notes.rst | 165 +++++++++++++++++++++++++++++++++++++++++++ 5 files changed, 347 insertions(+), 1 deletion(-) create mode 100644 docs/api-docs.rst create mode 100644 docs/developer-guides.rst create mode 100644 docs/installation-guides.rst create mode 100644 docs/release-notes.rst diff --git a/E2Manager/container-tag.yaml b/E2Manager/container-tag.yaml index e22b9c2..a2f2ee6 100644 --- 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. --- -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 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 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 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 , 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 +============ +.. + +.: + +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 +======= +.. + +: + +Before starting the installation of , some planning must preceed. + +.. note:any preperation you need before setting up sotfware and hardware + + +Hardware requirements +===================== +.. + +: + +Following minimum hardware requirements must be met for installation of : + ++--------------------+----------------------------------------------------+ +| **HW Aspect** | **Requirement** | +| | | ++--------------------+----------------------------------------------------+ +| **# of servers** | | ++--------------------+----------------------------------------------------+ +| **CPU** | | +| | | ++--------------------+----------------------------------------------------+ +| **RAM** | | +| | | ++--------------------+----------------------------------------------------+ +| **Disk** | | +| | | ++--------------------+----------------------------------------------------+ +| **NICs** | | +| | | +| | | +| | | +| | | +| | | ++--------------------+----------------------------------------------------+ + + + + + +Software installation and deployment +========================================== +.. + +: + +This section describes the installation of the installation on the reference hardware. + + + +References +========== +.. + +: + +OpenStack +^^^^^^^^^^^ + + diff --git a/docs/release-notes.rst b/docs/release-notes.rst new file mode 100644 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 of . + +.. contents:: + :depth: 3 + :local: + + +Version history +--------------- + ++--------------------+--------------------+--------------------+--------------------+ +| **Date** | **Ver.** | **Author** | **Comment** | +| | | | | ++--------------------+--------------------+--------------------+--------------------+ +| 20XX-XX-XX | 0.1.0 | | First draft | +| | | | | ++--------------------+--------------------+--------------------+--------------------+ +| | 0.1.1 | | | +| | | | | ++--------------------+--------------------+--------------------+--------------------+ +| | 1.0 | | | +| | | | | ++--------------------+--------------------+--------------------+--------------------+ + + +Summary +======= + + + + + + +Release Data +============ + + +: + ++--------------------------------------+--------------------------------------+ +| **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 +~~~~~~~~~~~~~~~~~~~~~~~ + + +: + +**JIRA BACK-LOG:** + ++--------------------------------------+--------------------------------------+ +| **JIRA REFERENCE** | **SLOGAN** | +| | | ++--------------------------------------+--------------------------------------+ +| | | +| | | +| | | ++--------------------------------------+--------------------------------------+ +| | | +| | | +| | | ++--------------------------------------+--------------------------------------+ + +Bug corrections +~~~~~~~~~~~~~~~~~~~~~ + +**JIRA TICKETS:** + ++--------------------------------------+--------------------------------------+ +| **JIRA REFERENCE** | **SLOGAN** | +| | | ++--------------------------------------+--------------------------------------+ +| | | +| | | +| | | ++--------------------------------------+--------------------------------------+ +| | | +| | | +| | | ++--------------------------------------+--------------------------------------+ + +Deliverables +---------------- + +Software deliverables +^^^^^^^^^^^^^^^^^^^^^^^ + + + +: + +Documentation deliverables +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + + + +: + + +Known Limitations, Issues and Workarounds +========================================= + +System Limitations +^^^^^^^^^^^^^^^^^^^^ + + + + +Known issues +^^^^^^^^^^^^^^^ + + +: + +**JIRA TICKETS:** + ++--------------------------------------+--------------------------------------+ +| **JIRA REFERENCE** | **SLOGAN** | +| | | ++--------------------------------------+--------------------------------------+ +| | | +| | | +| | | ++--------------------------------------+--------------------------------------+ +| | | +| | | +| | | ++--------------------------------------+--------------------------------------+ + +Workarounds +^^^^^^^^^^^^^^^^^ + + + + + + +References +========== + + + + + -- 2.16.6