From: demx8as6 Date: Wed, 13 Nov 2019 22:57:47 +0000 (+0100) Subject: Refactoring of Docs X-Git-Tag: 2.2.0~74 X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=commitdiff_plain;h=2493dbcef18c525e94b44d9250899283cc6dddc0;p=oam.git Refactoring of Docs The docs folder was refactored accroding to the new templates and instructions provided by the DOC project. IssueID: OAM-21 Change-Id: I51efbb70699e1d6dc49ab8fc38d33481ad8d6f2a Signed-off-by: demx8as6 --- diff --git a/ .readthedocs.yaml b/ .readthedocs.yaml new file mode 100644 index 0000000..fba6092 --- /dev/null +++ b/ .readthedocs.yaml @@ -0,0 +1,17 @@ +--- +version: 2 + +formats: + - htmlzip + +build: + image: latest + +python: + version: 3.7 + install: + - requirements: docs/requirements-docs.txt + +sphinx: + configuration: docs/conf.py + \ No newline at end of file diff --git a/.gitignore b/.gitignore index fcb3c4d..5fe0c16 100644 --- a/.gitignore +++ b/.gitignore @@ -45,3 +45,7 @@ release.properties # VES related */**/json/examples *.log + +# documentation +.tox +docs/_build/ \ No newline at end of file diff --git a/docs/_static/logo.png b/docs/_static/logo.png new file mode 100644 index 0000000..c3b6ce5 Binary files /dev/null and b/docs/_static/logo.png differ diff --git a/docs/conf.py b/docs/conf.py new file mode 100644 index 0000000..771ac9b --- /dev/null +++ b/docs/conf.py @@ -0,0 +1,6 @@ +from docs_conf.conf import * +linkcheck_ignore = [ + 'http://localhost.*', + 'http://127.0.0.1.*', + 'https://gerrit.o-ran-sc.org.*' +] \ No newline at end of file diff --git a/docs/conf.yaml b/docs/conf.yaml new file mode 100644 index 0000000..62b79fd --- /dev/null +++ b/docs/conf.yaml @@ -0,0 +1,3 @@ +--- +project_cfg: oran +project: oam \ No newline at end of file diff --git a/docs/favicon.ico b/docs/favicon.ico new file mode 100644 index 0000000..00b0fd0 Binary files /dev/null and b/docs/favicon.ico differ diff --git a/docs/index.rst b/docs/index.rst new file mode 100644 index 0000000..c243ffb --- /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) 2019 highstreet technologies and others + +.. _oam: + +.. OAM Operation and Maintenance master + +OAM Operation and Maintenance +============================= + + +.. toctree:: + :maxdepth: 2 + :caption: Contents: + + overview.rst + release-notes.rst + +* :ref:`search` diff --git a/docs/overview.rst b/docs/overview.rst new file mode 100644 index 0000000..e66e599 --- /dev/null +++ b/docs/overview.rst @@ -0,0 +1,56 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. SPDX-License-Identifier: CC-BY-4.0 +.. Copyright (C) 2019 highstreet technologies and others + +OAM Operation and Maintenance Overview +====================================== + +The O-RAN SC OAM provides administrative and operator +functions for O-RAN components, such as Near-Realtime-RAN-Inelegent-Controller, +O-RAN Centralized Unit, O-RAN Distributed Unit and O-RAN Radio Unit. + +The project follows the specifications for the O1 interface as provided by +O-RAN Working Group1. + + +Project Resources +----------------- + +The source code is available from the Linux Foundation Gerrit server: + + ``_ + +The build (CI) jobs are in the Linux Foundation Jenkins server: + + ``_ + +Issues are tracked in the Linux Foundation Jira server: + + ``_ + +Project information is available in the Linux Foundation Wiki: + + ``_ + + +Scope +----- + +According to the O-RAN-SC-OAM-Architecture document all ManagedElements +(near-real-time-RIC, O-CU-CP, O-CU-UP, O-DU and O-RU) implement the +O1-interface. + +The O-RAN-OAM-interface specification defines + +- a NetConf-Server for Configuration Management (CM) and +- a http-client for Fault Managment (FM), Performance Management (PM) and other + events on each Management-Service-Provider (MnS-Provider) running on the + ManagedElement (ME). + +THe O-RAN-SC-OAM project provides reference implementation according to the +O-RAN OAM (WG1) documents. In addition we provide a common MnS-Consumer for +development and module test purposes. The assumption is that the projects +for the ManagedElements can concentrate on the more important user-plane. + +Of cause each project needs its own OAM repo to address the specific needs +of the ManagedElement. diff --git a/docs/release-notes.rst b/docs/release-notes.rst new file mode 100644 index 0000000..c7bb661 --- /dev/null +++ b/docs/release-notes.rst @@ -0,0 +1,50 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. SPDX-License-Identifier: CC-BY-4.0 +.. Copyright (C) 2019 highstreet technologies GmbH + + +Operation and Maintenance Release Notes +======================================= + +This document provides the release notes for O-RAN-SC Amber release of the Operation and Maintenance (OAM) project. + +.. contents:: + :depth: 3 + :local: + + +Version history +--------------- + ++--------------------+--------------------+--------------------+--------------------+ +| **Date** | **Ver.** | **Author** | **Comment** | +| | | | | ++--------------------+--------------------+--------------------+--------------------+ +| 2019-09-08 | 0.1.0 | | Initial Version | +| | | | | ++--------------------+--------------------+--------------------+--------------------+ +| 2019-09-18 | 0.1.1 | | Initial Version | +| | | | DEV environment | ++--------------------+--------------------+--------------------+--------------------+ +| 2019-11-14 | 1.0 | | Docs added | +| | | | | ++--------------------+--------------------+--------------------+--------------------+ + + +Summary +------- + +According to the O-RAN-SC-OAM-Architecture document all ManagedElements +(near-real-time-RIC, O-CU-CP, O-CU-UP, O-DU and O-RU) implement the O1-interface. + +The O-RAN-OAM-interface specification defines + +a NetConf-Server for Configuration Management (CM) and +a http-client for Fault Managment (FM), Performance Management (PM) and other events +on each Management-Service-Provider (MnS-Provider) running on the ManagedElement (ME). + + + +The O-RAN-SC-OAM project provides reference implementation according to the O-RAN OAM (WG1) documents. +In addition we provide a common MnS-Consumer for development and module test purposes. +The assumption is that the projects for the ManagedElements can concentrate on the more important user-plane. diff --git a/docs/requirements-docs.txt b/docs/requirements-docs.txt new file mode 100644 index 0000000..4f9d174 --- /dev/null +++ b/docs/requirements-docs.txt @@ -0,0 +1,5 @@ +sphinx +sphinx-rtd-theme +sphinxcontrib-httpdomain +recommonmark +lfdocs-conf \ No newline at end of file diff --git a/solution/dev/ves-test-collector/client-scripts-ves-v7/jcurl.sh b/solution/dev/ves-test-collector/client-scripts-ves-v7/jcurl.sh deleted file mode 100755 index 14df8fa..0000000 --- a/solution/dev/ves-test-collector/client-scripts-ves-v7/jcurl.sh +++ /dev/null @@ -1,19 +0,0 @@ -#!/bin/bash -################################################################################ -# -# Copyright 2019 highstreet technologies GmbH and others -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# 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. -# - -java -classpath jcurl.jar com.highstreet.technologies.jcurl.Program "$@" diff --git a/tox.ini b/tox.ini new file mode 100644 index 0000000..9ab0da4 --- /dev/null +++ b/tox.ini @@ -0,0 +1,30 @@ +# documentation only +[tox] +minversion = 2.0 +envlist = + docs, + docs-linkcheck, +skipsdist = true + +[testenv:docs] +basepython = python3 +deps = + sphinx + sphinx-rtd-theme + sphinxcontrib-httpdomain + recommonmark + lfdocs-conf + +commands = + sphinx-build -W -b html -n -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/html + echo "Generated docs available in {toxinidir}/docs/_build/html" +whitelist_externals = echo + +[testenv:docs-linkcheck] +basepython = python3 +deps = sphinx + sphinx-rtd-theme + sphinxcontrib-httpdomain + recommonmark + lfdocs-conf +commands = sphinx-build -W -b linkcheck -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/linkcheck \ No newline at end of file