From ef963b9e6893cc03651ba56cdbac257a09de2a79 Mon Sep 17 00:00:00 2001 From: elinuxhenrik Date: Fri, 16 Dec 2022 08:34:17 +0100 Subject: [PATCH] Update documentation Issue-ID: NONRTRIC-819 Signed-off-by: elinuxhenrik Change-Id: Ibd618c219e1b648a7e73d416a70e03448123d604 --- docs/conf.py | 4 ++++ docs/overview.rst | 21 ++++++++++++++++++++- docs/release-notes.rst | 18 ++++++++++++++++++ 3 files changed, 42 insertions(+), 1 deletion(-) diff --git a/docs/conf.py b/docs/conf.py index 14f0e3ff..3695020e 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -27,7 +27,9 @@ rappcataloguebranch = 'latest' helmmanagerbranch = 'latest' ransliceassurancebranch = 'latest' orufhrecoverybranch = 'latest' +authtokenfetchbranch = 'latest' a1policymanagementservicebranch = 'latest' +smebranch = 'latest' onapbranch = 'latest' linkcheck_ignore = [ @@ -53,5 +55,7 @@ intersphinx_mapping['rappcatalogue'] = ('https://docs.o-ran-sc.org/projects/o-ra intersphinx_mapping['helmmanager'] = ('https://docs.o-ran-sc.org/projects/o-ran-sc-nonrtric-plt-helmmanager/en/%s' % helmmanagerbranch, None) intersphinx_mapping['ransliceassurance'] = ('https://docs.o-ran-sc.org/projects/o-ran-sc-nonrtric-rapp-ransliceassurance/en/%s' % ransliceassurancebranch, None) intersphinx_mapping['orufhrecovery'] = ('https://docs.o-ran-sc.org/projects/o-ran-sc-nonrtric-rapp-orufhrecovery/en/%s' % orufhrecoverybranch, None) +intersphinx_mapping['authtokenfetch'] = ('https://docs.o-ran-sc.org/projects/o-ran-sc-nonrtric/en/%s' % authtokenfetchbranch, None) intersphinx_mapping['a1policymanagementservice'] = ('https://docs.o-ran-sc.org/projects/o-ran-sc-nonrtric-plt-a1policymanagementservice/en/%s' % a1policymanagementservicebranch, None) +intersphinx_mapping['sme'] = ('https://docs.o-ran-sc.org/projects/o-ran-sc-nonrtric-plt-sme/en/%s' % smebranch, None) intersphinx_mapping['onapa1policymanagementservice'] = ('https://docs.onap.org/projects/onap-ccsdk-oran/en/%s' % onapbranch, None) diff --git a/docs/overview.rst b/docs/overview.rst index 09bfdbf8..9b33c4f3 100644 --- a/docs/overview.rst +++ b/docs/overview.rst @@ -38,13 +38,15 @@ These are the components that make up the Non-RT-RIC: * `DMaaP/Kafka Information Producer Adapters <#dmaap-kafka-information-producer-adapters>`_. :doc:`Documentation site adapter `. :doc:`Documentation site mediator `. * `Initial Non-RT-RIC App Catalogue <#initial-non-rt-ric-app-catalogue>`_. :doc:`Documentation site `. * `Initial K8S Helm Chart LCM Manager <#id5>`_. :doc:`Documentation site `. -* `Auth Token Fetch <#id6>`_. +* `Auth Token Fetch <#id6>`_. :doc:`Documentation site `. +* `Service Management & Exposure (SME) <#service-management-and-exposure>`_. :doc:`Documentation site `. * `Test Framework <#id7>`_. * `Use Cases: <#non-rt-ric-use-cases>`_ * "Helloworld" O-RU Fronthaul Recovery use case. :doc:`Documentation site `. * "Helloworld" O-DU Slice Assurance use case. :doc:`Documentation site `. + Non-RT-RIC Control Panel / NONRTRIC Dashboard ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -220,6 +222,23 @@ Implementation: - Repo: *nonrtric/plt/helmmanager* - Documentation at the :doc:`Helm Manager documentation site `. +Service Management and Exposure +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +An initial implementation of the CAPIF Core service. It implements the following CAPIF APIs: +- API Provider Management +- Publish Service +- Discover Service +- API Invoker Management +- Security +- Events + +Implementation: + +- Implemented in Go +- Repo: *nonrtric/plt/sme* +- Documentation at the :doc:`Service Management & Exposure (SME) documentation site `. + Auth Token Fetch ~~~~~~~~~~~~~~~~ diff --git a/docs/release-notes.rst b/docs/release-notes.rst index fd271996..ca5ad04b 100644 --- a/docs/release-notes.rst +++ b/docs/release-notes.rst @@ -9,6 +9,24 @@ Release-Notes This document provides the release notes for the release of the different parts of the Non-RT RIC. +Since release F the products has been moved to separate repos. The release notes for the products can now be found: + +* :doc:`Non-RT-RIC Control Panel `. +* :doc:`Information Coordinator Service `. +* :doc:`A1 Policy Management Service `. +* :doc:`Near-RT RIC A1 Simulator `. +* DMaaP/Kafka Information Producer Adapters. :doc:`DMaaPAdapter `. :doc:`DMaaP Mediator Producer `. +* :doc:`Non-RT-RIC App Catalogue `. +* :doc:`K8S Helm Chart LCM Manager `. +* :doc:`Auth Token Fetch `. +* :doc:`Service Management & Exposure (SME) `. +* Use Cases: + + * :doc:`"Helloworld" O-RU Fronthaul Recovery use case `. + * :doc:`"Helloworld" O-DU Slice Assurance use case `. + + + Bronze ------ +-----------------------------+---------------------------------------------------+ -- 2.16.6