From: John  Keeney <john.keeney@est.tech>
Date: Tue, 29 Aug 2023 11:00:11 +0000 (+0000)
Subject: Merge "Update Documentation for H-RELEASE"
X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=commitdiff_plain;h=f8ea24d7c86ce648f4955ebc0ecdaa4cff1619ef;hp=333e6d78ea15d1b8eefafcab426ac2fc641386de;p=nonrtric.git

Merge "Update Documentation for H-RELEASE"
---

diff --git a/.readthedocs.yaml b/.readthedocs.yaml
index 70f19d8d..8482a3ad 100644
--- a/.readthedocs.yaml
+++ b/.readthedocs.yaml
@@ -1,5 +1,5 @@
 #  ============LICENSE_START=======================================================
-#  Copyright (C) 2020-2022 Nordix Foundation
+#  Copyright (C) 2020-2023 Nordix Foundation
 #  ================================================================================
 #  Licensed under the Apache License, Version 2.0 (the "License");
 #  you may not use this file except in compliance with the License.
@@ -16,20 +16,19 @@
 #  SPDX-License-Identifier: Apache-2.0
 #  ============LICENSE_END=========================================================
 ---
-# Read the Docs configuration file
-# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
 version: 2
 
 formats:
   - htmlzip
 
 build:
-  image: latest
+  os: ubuntu-20.04
+  tools:
+    python: "3.8"
 
 python:
-  version: 3.7
   install:
-    - requirements: docs/requirements-docs.txt
+  - requirements: docs/requirements-docs.txt
 
 sphinx:
-  configuration: docs/conf.py
+  configuration: docs/conf.py
\ No newline at end of file
diff --git a/docs/conf.py b/docs/conf.py
index 3695020e..036bca6c 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -30,6 +30,7 @@ orufhrecoverybranch = 'latest'
 authtokenfetchbranch = 'latest'
 a1policymanagementservicebranch = 'latest'
 smebranch = 'latest'
+ranpmbranch = 'latest'
 onapbranch = 'latest'
 
 linkcheck_ignore = [
@@ -58,4 +59,5 @@ intersphinx_mapping['orufhrecovery'] = ('https://docs.o-ran-sc.org/projects/o-ra
 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['ranpm'] = ('https://docs.o-ran-sc.org/projects/o-ran-sc-nonrtric-plt-ranpm/en/%s' % ranpmbranch, None)
 intersphinx_mapping['onapa1policymanagementservice'] = ('https://docs.onap.org/projects/onap-ccsdk-oran/en/%s' % onapbranch, None)
diff --git a/docs/images/nonrtric-architecture-H.png b/docs/images/nonrtric-architecture-H.png
new file mode 100644
index 00000000..9efbd701
Binary files /dev/null and b/docs/images/nonrtric-architecture-H.png differ
diff --git a/docs/overview.rst b/docs/overview.rst
index 6f96be83..04bb0d3a 100644
--- a/docs/overview.rst
+++ b/docs/overview.rst
@@ -2,7 +2,7 @@
 .. SPDX-License-Identifier: CC-BY-4.0
 .. Copyright (C) 2021 Nordix
 
-.. |archpic| image:: ./images/nonrtric-architecture-F.png
+.. |archpic| image:: ./images/nonrtric-architecture-H.png
   :alt: Image: O-RAN SC - NONRTRIC Overall Architecture
 
 Summary
@@ -73,6 +73,7 @@ The ICS is a data subscription service which decouples data producers from data
 A data consumer can have several active data subscriptions (Information Job). One Information Job consists of the type of data to produce and additional parameters, which may be different for different data types. These parameters are not defined or limited by this service.
 
 Maintains a registry of:
+
 - Information Types / schemas
 - Information Producers
 - Information Consumers
@@ -264,6 +265,22 @@ The auth-token-fetch is configured by the following environment variables.
 * AUTH_SERVICE_URL - the URL to the authentication service (Keycloak)
 * REFRESH_MARGIN_SECONDS - how long in advance before the authorization token expires it is refreshed
 
+RAN Performance Monitoring Functions (File-based PM)
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Functions to collect/parse/filter/store/forward file-based & event-based RAN PM data:
+
+- End-to-end tool-chain to collection, parsing, filtering and delivery of file-based RAN PM observability data
+- PM report data format defined by 3GPP (TS 32.432 and 3GPP TS 32.435)
+- High performance, fully scalable
+- Subscribers (e.g. rApps) can subscribe for chosen measurement types from specific resources in the network
+
+Implementation:
+
+- Implemented in Go, Java and Python
+- Repo: *nonrtric/plt/ranpm*
+- Documentation at the :doc:`Non-RT RIC RAN PM Usecase / Functions documentation site <ranpm:index>`.
+
 Non-RT-RIC Test Framework
 ~~~~~~~~~~~~~~~~~~~~~~~~~
 
diff --git a/tox.ini b/tox.ini
index 00dd3b8a..c4e42576 100644
--- a/tox.ini
+++ b/tox.ini
@@ -16,7 +16,7 @@
 
 # documentation only
 [tox]
-minversion = 2.0
+minversion = 4.0
 envlist =
     docs,
     docs-linkcheck,