From cdf0733d73846d54ba51eee6dd49615d2658eba8 Mon Sep 17 00:00:00 2001 From: weichen Date: Wed, 1 Sep 2021 21:43:29 -0400 Subject: [PATCH] add ric-app-hw-go document Signed-off-by: weichen Change-Id: I2ae48c232cb7e31297b68198c9a3b18e9ba30562 --- docs/conf.py | 2 ++ docs/projects.rst | 19 ++++++------------- docs/release-notes.rst | 9 +++++++++ 3 files changed, 17 insertions(+), 13 deletions(-) diff --git a/docs/conf.py b/docs/conf.py index 0755aab..4c9b822 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -21,6 +21,8 @@ intersphinx_mapping['ric-app-hw'] = ('https://docs.o-ran-sc.org/projects/o-ran-s intersphinx_mapping['ric-app-qp'] = ('https://docs.o-ran-sc.org/projects/o-ran-sc-ric-app-qp/en/%s' % branch, None) intersphinx_mapping['ric-app-ts'] = ('https://docs.o-ran-sc.org/projects/o-ran-sc-ric-app-ts/en/%s' % branch, None) intersphinx_mapping['ric-app-ad'] = ('https://docs.o-ran-sc.org/projects/o-ran-sc-ric-app-ad/en/%s' % branch, None) +intersphinx_mapping['ric-app-hw-go'] = ('https://docs.o-ran-sc.org/projects/o-ran-sc-ric-app-hw-go/en/%s' % branch, None) + #(near realtime)RIC platform intersphinx_mapping['com-log'] = ('https://docs.o-ran-sc.org/projects/o-ran-sc-com-log/en/%s' % branch, None) diff --git a/docs/projects.rst b/docs/projects.rst index 113f382..3b23d4e 100644 --- a/docs/projects.rst +++ b/docs/projects.rst @@ -17,14 +17,15 @@ More detailed function documentation can be found as follow: .. * :doc:`Alarm Go Library ` .. * :doc:`Admission Control xAPP ` +* :doc:`Anomaly Detection xAPP ` * :doc:`GS-lite Stream Processing Engine ` * :doc:`HelloWorld xAPP ` +* :doc:`HW-go xAPP ` * :doc:`KPI monitoring ` * :doc:`QoE Predictor xApp ` * :doc:`RIC APP ML ` * :doc:`RIC Measurement Campaign (MC) xApp ` * :doc:`Traffic Steering xAPP ` -* :doc:`Anomaly Detection xAPP ` Near Realtime RAN Intelligent Controller (RIC) @@ -66,15 +67,6 @@ More detailed function documentation can be found as follow: * :doc:`A1 Interface Simulator ` * :doc:`Non-RT RIC Components ` - - + A1 Policy Management Service - + A1 Controller - + A1 Enrichment Information Coordinator - + Non-RT-RIC App Catalogue - + Helm Chart Manager - + HealtCheck use case - + O-RU closed loop recovery use case - * :doc:`Non-RT RIC Control Panel ` @@ -84,11 +76,12 @@ The O-RAN-SC-OAM project provides reference implementation according to the O-RA More detailed function documentation can be found as follow: +* :doc:`NF OAM Adopter ` +* :doc:`Non-RT RIC Control Panel ` * :doc:`OAM Operation and Maintenance ` * :doc:`RIC Dashboard ` -* :doc:`Non-RT RIC Control Panel ` * :doc:`TR069 Adapter ` -* :doc:`NF OAM Adopter ` + O-RAN Central Unit (OCU) @@ -135,8 +128,8 @@ Initial simulators used for testing O-RAN NF interfaces. More detailed function documentation can be found as follow: -* :doc:`SIM/O1-Interface ` * :doc:`SIM/A1-Interface ` +* :doc:`SIM/O1-Interface ` Integration and Testing (INT) diff --git a/docs/release-notes.rst b/docs/release-notes.rst index 8799059..613186f 100644 --- a/docs/release-notes.rst +++ b/docs/release-notes.rst @@ -82,6 +82,10 @@ Anomaly Detection (AD) is an xApp in the Traffic Steering O-RAN use case. * :doc:`Anomaly Detection xApp Release-notes ` +This repository contains open-source code for a prototype HW-go xAPP for near real-time RAN Intelligent Controller which makes use of go Xapp Framework. + +* :doc:`HW-go xAPP Release-notes ` + Near Realtime RAN Intelligent Controller (RIC) features @@ -167,6 +171,7 @@ xapp-frame is a simple framework for rapid development of RIC xapps, and support .. * :doc:`xApp Python Release-notes` + Non-RealTime RAN Intelligent Controller (NONRTRIC) features ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ @@ -191,6 +196,7 @@ The O-RAN SC RIC Dashboard provides administrative and operator functions for a * :doc:`RIC Dashboard Release-notes ` + O-RAN Central Unit (OCU) features ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ @@ -207,6 +213,7 @@ O-DU Layer 2, which is O-DU layer intilaizations and exchange of F1 Setup Reques * :doc:`O-DU Layer 2 Release-notes ` + O-RAN Distributed Unit Low Layers (ODULOW) features ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ @@ -215,6 +222,7 @@ O-DU Layer 1, which is the O-RAN FHI Lib built on top of DPDK to perform U-plane * :doc:`O-DU Layer 1 Release-notes ` + Infrastructure (INF) features ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ @@ -228,6 +236,7 @@ Realtime Platform, which implements a real time platform to deploy the O-CU and .. * :doc:`SIM/O1-Interface Release-notes ` + Integration and Testing (INT) features ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -- 2.16.6