From: Mohamed Abukar Date: Thu, 18 Jun 2020 14:58:50 +0000 (+0300) Subject: Releasing Docker image X-Git-Tag: 0.5.1~14 X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=commitdiff_plain;h=415d57ba4abb91ad635584372672d4a7dd76e4aa;p=ric-plt%2Fo1.git Releasing Docker image Change-Id: I93d68e0b9c54c26a60972591cb4f08805a08ab6b Signed-off-by: Mohamed Abukar --- 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..922e22f --- /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.*' +] diff --git a/docs/conf.yaml b/docs/conf.yaml new file mode 100644 index 0000000..554516a --- /dev/null +++ b/docs/conf.yaml @@ -0,0 +1,3 @@ +--- +project_cfg: oran +project: ric-plt/o1 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..81be866 --- /dev/null +++ b/docs/index.rst @@ -0,0 +1,30 @@ +.. +.. 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. +.. + +Welcome to O-RAN Application Manager Documentation +================================================== + +.. toctree:: + :maxdepth: 2 + :caption: Contents: + + release-notes.rst + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` diff --git a/docs/release-notes.rst b/docs/release-notes.rst new file mode 100644 index 0000000..7896006 --- /dev/null +++ b/docs/release-notes.rst @@ -0,0 +1,148 @@ +.. +.. 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. +.. + + +Release-Notes +============= + + +This document provides the release notes for O-RAN SC Bronze release of ric-plt/o1. + +.. contents:: + :depth: 3 + :local: + + +Version history +--------------- + ++--------------------+--------------------+--------------------+--------------------+ +| **Date** | **Ver.** | **Author** | **Comment** | +| | | | | ++--------------------+--------------------+--------------------+--------------------+ +| 2020-06-18 | v0.4.4 | Abukar Mohamed | Bronze Release | +| | | | | ++--------------------+--------------------+--------------------+--------------------+ + + +Summary +------- + + + +Release Data +------------ + ++--------------------------------------+--------------------------------------+ +| **Project** | O1 Mediator | +| | | ++--------------------------------------+--------------------------------------+ +| **Repo/commit-ID** | ric-plt/o1 | +| | | ++--------------------------------------+--------------------------------------+ +| **Release designation** | Bronze | +| | | ++--------------------------------------+--------------------------------------+ +| **Release date** | 2020-05-07 | +| | | ++--------------------------------------+--------------------------------------+ +| **Purpose of the delivery** | First Release | +| | | ++--------------------------------------+--------------------------------------+ + + + +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 +---------- + diff --git a/docs/requirements-docs.txt b/docs/requirements-docs.txt new file mode 100644 index 0000000..09a0c1c --- /dev/null +++ b/docs/requirements-docs.txt @@ -0,0 +1,5 @@ +sphinx +sphinx-rtd-theme +sphinxcontrib-httpdomain +recommonmark +lfdocs-conf diff --git a/releases/container-release-ric-plt-o1.yaml b/releases/container-release-ric-plt-o1.yaml new file mode 100644 index 0000000..42a504c --- /dev/null +++ b/releases/container-release-ric-plt-o1.yaml @@ -0,0 +1,10 @@ +--- +distribution_type: container +container_release_tag: 0.4.4 +container_pull_registry: nexus3.o-ran-sc.org:10004 +container_push_registry: nexus3.o-ran-sc.org:10002 +project: ric-plt/o1 +ref: c996c56ce5510957e93df391a43534a5a1efd6e4 +containers: + - name: ric-plt-o1 + version: 0.4.4 diff --git a/tox.ini b/tox.ini new file mode 100644 index 0000000..8a8d0a4 --- /dev/null +++ b/tox.ini @@ -0,0 +1,38 @@ +# documentation only +[tox] +minversion = 2.0 +envlist = + docs, + docs-linkcheck, +skipsdist = true + +[testenv:docs] +passenv = + http_proxy + https_proxy + +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] +passenv = + http_proxy + https_proxy + +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