add ric-app-hw-go document

Signed-off-by: weichen <niweichen@chinamobile.com>
Change-Id: I2ae48c232cb7e31297b68198c9a3b18e9ba30562

diff --git a/docs/conf.py b/docs/conf.py
index 0755aab..4c9b822 100644 (file)
--- 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 (file)
--- 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 <ric-plt-alarm-go:index>`
 .. * :doc:`Admission Control xAPP <ric-app-admin:index>`
 
+* :doc:`Anomaly Detection xAPP <ric-app-ad:index>`
 * :doc:`GS-lite Stream Processing Engine <com-gs-lite:index>`
 * :doc:`HelloWorld xAPP  <ric-app-hw:index>`
+* :doc:`HW-go xAPP <ric-app-hw-go:index>`
 * :doc:`KPI monitoring <ric-app-kpimon:index>`
 * :doc:`QoE Predictor xApp <ric-app-qp:index>`
 * :doc:`RIC APP ML <ric-app-ml:index>`
 * :doc:`RIC Measurement Campaign (MC) xApp <ric-app-mc:index>`
 * :doc:`Traffic Steering xAPP <ric-app-ts:index>`
-* :doc:`Anomaly Detection xAPP <ric-app-ad:index>`
 
 
 Near Realtime RAN Intelligent Controller (RIC)
@@ -66,15 +67,6 @@ More detailed function documentation can be found as follow:
 
 * :doc:`A1 Interface Simulator <sim-a1-interface:index>`
 * :doc:`Non-RT RIC Components <nonrtric:index>`
-
-   + 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 <nonrtric-controlpanel:index>`
 
 
@@ -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 <oam-nf-oam-adopter:index>`
+* :doc:`Non-RT RIC Control Panel <nonrtric-controlpanel:index>`
 * :doc:`OAM Operation and Maintenance <oam:index>`
 * :doc:`RIC Dashboard <portal-ric-dashboard:index>`
-* :doc:`Non-RT RIC Control Panel <nonrtric-controlpanel:index>`
 * :doc:`TR069 Adapter <oam-tr069-adapter:index>`
-* :doc:`NF OAM Adopter <oam-nf-oam-adopter:index>`
+
 
 
 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 <sim-o1-interface:index>`
 * :doc:`SIM/A1-Interface <sim-a1-interface:index>`
+* :doc:`SIM/O1-Interface <sim-o1-interface:index>`
 
 
 Integration and Testing (INT)

diff --git a/docs/release-notes.rst b/docs/release-notes.rst
index 8799059..613186f 100644 (file)
--- 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 <ric-app-ad: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 <ric-app-hw-go: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<ric-plt-xapp-frame-py: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 <portal-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-du-l2: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 <o-du-phy: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 <sim-o1-interface:release-notes>`
 
 
+
 Integration and Testing (INT) features
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^