From: elinuxhenrik Date: Thu, 23 Jun 2022 08:05:16 +0000 (+0200) Subject: Update documentation with links X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=commitdiff_plain;h=7608066817352827ad06fab710cc9138d015c259;p=nonrtric.git Update documentation with links Issue-ID: NONRTRIC-769 Signed-off-by: elinuxhenrik Change-Id: I8347097d66b53c0debf894ebf15bb864ab4bd70b --- diff --git a/docs/api-docs.rst b/docs/api-docs.rst index db23bcaf..33d8abb6 100644 --- a/docs/api-docs.rst +++ b/docs/api-docs.rst @@ -11,24 +11,8 @@ API-Docs Descriptions of the APIs to the Non-RT RIC functions can be found in the repos for the functions. -See Also: Non-RT RIC Control Panel -================================== - -The Non-RT RIC Control Panel provides a user interface that allows the user to interact with the Non-RT RIC. - -Documentation for the Control Panel can be found here: `Non-RT RIC Control Panel `_. - -It can be downloaded from here: :: - - git clone "https://gerrit.o-ran-sc.org/r/portal/nonrtric-controlpanel". - -See Also: A1 / Near-RT RIC simulator -==================================== - -The Near-RT RIC simulator simulates an A1 protocol termination endpoint. - -Documentation for the simulator can be found here: `A1 Interface Simulator `_. - -It can be downloaded from here: :: - - git clone "https://gerrit.o-ran-sc.org/r/sim/a1-interface" +* DMaaP Mediator Producer :doc:`API Docs `. +* Helm Manager :doc:`API Docs `. +* A1 Policy Management Service :doc:`API Docs `. +* Information Coordinator Service :doc:`API Docs `. +* rApp Catalogue :doc:`API Docs `. \ No newline at end of file diff --git a/docs/conf.py b/docs/conf.py index 8c7a946b..49aaa340 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -3,6 +3,7 @@ from docs_conf.conf import * #branch configuration branch = 'latest' +onapbranch = 'latest' linkcheck_ignore = [ 'http://localhost.*', @@ -10,10 +11,22 @@ linkcheck_ignore = [ 'https://gerrit.o-ran-sc.org.*', ] -extensions = ['sphinx.ext.intersphinx',] +extensions = [ + 'sphinx.ext.intersphinx', + 'sphinx.ext.autosectionlabel', +] #intershpinx mapping with other projects intersphinx_mapping = {} -intersphinx_mapping['nonrtric-controlpanel'] = ('https://docs.o-ran-sc.org/projects/o-ran-sc-portal-nonrtric-controlpanel/en/%s' % branch, None) -intersphinx_mapping['sim-a1-interface'] = ('https://docs.o-ran-sc.org/projects/o-ran-sc-sim-a1-interface/en/%s' % branch, None) +intersphinx_mapping['controlpanel'] = ('https://docs.o-ran-sc.org/projects/o-ran-sc-portal-nonrtric-controlpanel/en/%s' % branch, None) +intersphinx_mapping['simulator'] = ('https://docs.o-ran-sc.org/projects/o-ran-sc-sim-a1-interface/en/%s' % branch, None) +intersphinx_mapping['dmaapmediatorproducer'] = ('https://docs.o-ran-sc.org/projects/o-ran-sc-nonrtric-plt-dmaapmediatorproducer/en/%s' % branch, None) +intersphinx_mapping['dmaapadapter'] = ('https://docs.o-ran-sc.org/projects/o-ran-sc-nonrtric-plt-dmaapadapter/en/%s' % branch, None) +intersphinx_mapping['informationcoordinatorservice'] = ('https://docs.o-ran-sc.org/projects/o-ran-sc-nonrtric-plt-informationcoordinatorservice/en/%s' % branch, None) +intersphinx_mapping['rappcatalogue'] = ('https://docs.o-ran-sc.org/projects/o-ran-sc-nonrtric-plt-rappcatalogue/en/%s' % branch, None) +intersphinx_mapping['helmmanager'] = ('https://docs.o-ran-sc.org/projects/o-ran-sc-nonrtric-plt-helmmanager/en/%s' % branch, None) +intersphinx_mapping['ransliceassurance'] = ('https://docs.o-ran-sc.org/projects/o-ran-sc-nonrtric-rapp-ransliceassurance/en/%s' % branch, None) +intersphinx_mapping['orufhrecovery'] = ('https://docs.o-ran-sc.org/projects/o-ran-sc-nonrtric-rapp-orufhrecovery/en/%s' % branch, None) +intersphinx_mapping['a1policymanagementservice'] = ('https://docs.o-ran-sc.org/projects/o-ran-sc-nonrtric-plt-a1policymanagementservice/en/%s' % branch, None) +intersphinx_mapping['onapa1policymanagementservice'] = ('https://docs.onap.org/projects/onap-ccsdk-oran/en/%s' % onapbranch, None) diff --git a/docs/index.rst b/docs/index.rst index 57a05097..d3ad7f65 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -16,5 +16,3 @@ Non-RT RIC ./requirements.rst ./installation-guide.rst ./release-notes.rst - -* :ref:`search` diff --git a/docs/overview.rst b/docs/overview.rst index 0623b33c..1195d6ef 100644 --- a/docs/overview.rst +++ b/docs/overview.rst @@ -28,23 +28,21 @@ NONRTRIC components These are the components that make up the Non-RT-RIC: -- Non-RT-RIC Control Panel -- Information Coordinator Service -- A1 Policy Management Service -- A1 Policy Controller / Adapter -- Near-RT RIC A1 Simulator -- Non-RT-RIC (Spring Cloud) Service Gateway -- Non-RT-RIC (Kong) Service Exposure Prototyping -- DMaaP/Kafka Information Producer Adapters -- Initial Non-RT-RIC App Catalogue -- Initial K8S Helm Chart LCM Manager -- Test Framework -- Use Cases - - + "Helloworld" O-RU Fronthaul Recovery use case - + "Helloworld" O-DU Slice Assurance use case - -The source code for "E" Release is in the `NONRTRIC `_, `NONRTRIC-ControlPanel `_, and `Near-RT-RIC A1-Simulator `_ Gerrit source repositories (E-Release Branch). +* `Non-RT-RIC Control Panel <#non-rt-ric-control-panel-nonrtric-dashboard>`_. :doc:`Documentation site `. +* `Information Coordinator Service <#information-coordination-service>`_. :doc:`Documentation site `. +* `A1 Policy Management Service <#a1-policy-management-service-from-onap-ccsdk>`_. :doc:`Documentation site `. +* `A1 Policy Controller / Adapter <#a1-sdnc-controller-a1-adapter-controller-plugin>`_. +* `Near-RT RIC A1 Simulator <#a1-interface-near-rt-ric-simulator>`_. :doc:`Documentation site `. +* `Non-RT-RIC (Spring Cloud) Service Gateway <#non-rt-ric-spring-cloud-service-gateway>`_. +* `Non-RT-RIC (Kong) Service Exposure Prototyping <#non-rt-ric-kong-service-exposure-prototyping>`_. +* `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 `. +* `Test Framework <#id1>`_. +* `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 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -62,7 +60,7 @@ Implementation: - Frontend: Angular framework - Repo: *portal/nonrtric-controlpanel* - `Wiki `_ to set up in your local environment. -- Documentation at the `NONRTRIC-Portal documentation site `_. +- Documentation at the :doc:`NONRTRIC-Portal documentation site `. Information Coordination Service ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -83,7 +81,7 @@ Implementation: - Implemented as a Java Spring Boot application. - Repo: *nonrtric/plt/informationcoordinatorservice*. -- Documentation at the `Information Coordination Service site `_ +- Documentation at the :doc:`Information Coordination Service site `. A1 Policy Management Service (from ONAP CCSDK) ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -110,6 +108,8 @@ Implementation: - Implemented as a Java Spring Boot application. - Wiki: `A1 Policy Management Service in ONAP `_ . +- Repo: *nonrtric/plt/a1policymanagementservice*. +- Documentation at the :doc:`A1 Policy Management Service documentation site `. A1/SDNC Controller & A1 Adapter (Controller plugin) ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -141,7 +141,7 @@ Implementation: - Implemented as a Python application. - Repo: *sim/a1-interface*. -- Documentation at the `A1 Simulator documentation site `_ +- Documentation at the :doc:`A1 Simulator documentation site `. Non-RT-RIC (Spring Cloud) Service Gateway ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -183,8 +183,8 @@ There are two alternative implementations to allow Information Consumers to cons Implementation: -- Implementation in Java Spring (DMaaP Adapter), repo: *nonrtric/plt/dmaapadapter*, see `DMaaP Adapter documentation site `_. -- Implemention in Go (DMaaP Mediator Producer), repo: *nonrtric/plt/dmaapmediatorproducer*, see `DMaaP Mediator Producer documentation site `_. +- Implementation in Java Spring (DMaaP Adapter), repo: *nonrtric/plt/dmaapadapter*, see :doc:`DMaaP Adapter documentation site `. +- Implemention in Go (DMaaP Mediator Producer), repo: *nonrtric/plt/dmaapmediatorproducer*, see :doc:`DMaaP Mediator Producer documentation site `. Initial Non-RT-RIC App Catalogue ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -199,7 +199,7 @@ Implementation: - Implemented as a Java Spring Boot application. - Repo: *nonrtric/plt/rappcatalogue* -- Documentation at the `rApp Catalogue documentation site `_. +- Documentation at the :doc:`rApp Catalogue documentation site `. Initial K8S Helm Chart LCM Manager ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -217,15 +217,15 @@ Implementation: - Implemented as a Java Spring Boot application. - Repo: *nonrtric/plt/helmmanager* -- Documentation at the `Helm Manager documentation site `_. +- Documentation at the :doc:`Helm Manager documentation site `. Test Framework ~~~~~~~~~~~~~~ A full test environment with extensive test cases/scripts can be found in the ``test`` directory in the *nonrtric* source code. -Use Cases -~~~~~~~~~ +Non-RT-RIC Use Cases +~~~~~~~~~~~~~~~~~~~~ "Helloworld" O-RU Fronthaul Recovery use case ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ @@ -236,6 +236,7 @@ Implementation: - One version implemented in Python, one in Go as an Information Coordination Service Consumer, and one as an apex policy. - Repo: *nonrtric/rapp/orufhrecovery* +- Documentation at the :doc:`O-RU Fronthaul Recovery documentation site `. "Helloworld" O-DU Slice Assurance use case ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ @@ -246,4 +247,4 @@ Implementation: - One version implemented in Go as a micro service, one in Go as an Information Coordination Service Consumer. - Repo: *nonrtric/rapp/ransliceassurance* -- Documentation at the `O-DU Slice Assurance site `__. +- Documentation at the :doc:`O-DU Slice Assurance documentation site `.