Add ReadTheDocs configuration/site in repo root directory step #2
Issue-ID: NONRTRIC-864
Change-Id: I072c35678c114ea0f6be54d31e24650b17e312cb
Signed-off-by: JohnKeeney <john.keeney@est.tech>
diff --git a/datafilecollector/docs/conf.py b/datafilecollector/docs/conf.py
index 240d10c..bc39c07 100644
--- a/datafilecollector/docs/conf.py
+++ b/datafilecollector/docs/conf.py
@@ -21,13 +21,10 @@
branch = 'latest'
-language = 'en'
-
linkcheck_ignore = [
'http://localhost.*',
'http://127.0.0.1.*',
'https://gerrit.o-ran-sc.org.*',
- './pm-producer-api.html', #Generated file that doesn't exist at link check.
]
extensions = ['sphinx.ext.intersphinx',]
diff --git a/datafilecollector/docs/conf.yaml b/datafilecollector/docs/conf.yaml
index 8f24fdb..80dbabf 100644
--- a/datafilecollector/docs/conf.yaml
+++ b/datafilecollector/docs/conf.yaml
@@ -1,3 +1,3 @@
---
project_cfg: oran
-project: nonrtric-plt-pmproducer
+project: nonrtric-plt-datafilecollector
diff --git a/datafilecollector/docs/developer-guide.rst b/datafilecollector/docs/developer-guide.rst
index 38fa9dc..0c02a73 100644
--- a/datafilecollector/docs/developer-guide.rst
+++ b/datafilecollector/docs/developer-guide.rst
@@ -7,10 +7,10 @@
This document provides a quickstart for developers of the Non-RT RIC Data File Collector.
-Additional developer guides are available on the `O-RAN SC NONRTRIC Developer wiki <https://wiki.o-ran-sc.org/display/RICNR/Release+E>`_.
+Additional developer guides are available on the `O-RAN SC NONRTRIC Developer wiki <https://wiki.o-ran-sc.org/display/RICNR>`_.
-Data File Collector
--------------------
+Data File Collector Service
+---------------------------
The DFC is configured via the application.yaml file.
diff --git a/datafilecollector/docs/index.rst b/datafilecollector/docs/index.rst
index a0ef6fc..4010edb 100644
--- a/datafilecollector/docs/index.rst
+++ b/datafilecollector/docs/index.rst
@@ -2,8 +2,8 @@
.. SPDX-License-Identifier: CC-BY-4.0
.. Copyright (C) 2023 Nordix
-Non-RT RIC PM Producer
-======================
+Non-RT RIC PM Data File Collector
+=================================
.. toctree::
:maxdepth: 2
diff --git a/datafilecollector/docs/overview.rst b/datafilecollector/docs/overview.rst
index 6cf45a3..74e8e9b 100644
--- a/datafilecollector/docs/overview.rst
+++ b/datafilecollector/docs/overview.rst
@@ -10,25 +10,19 @@
Introduction
************
-The task of the Data File Collector is to collect files from traffical nodes in the RAN.
+The task of the Data File Collector is to collect OAM data files from RAN traffic-handling nodes.
The main use case is:
-* The DFC received a File Ready VES event from a Kafka topic. This contains a list of all available files.
-
-* The DFC fetches files that are not already fectched from the traffical node. This is done using one of the supported file transfer protocols.
-
+* The DFC receives a "File Ready" VES event from a Kafka topic. This contains a list of all available files.
+* The DFC fetches files that are not already fetched from the relevant RAN traffic-handling nodes. This is done using one of the supported file transfer protocols.
* Each file is stored in an S3 Object Store bucket or in the file system (in a persistent volume).
-
-* For each stored file, a file publish message is sent to a Kafka topic for further processing.
+* For each stored file, a "File Publish" message is sent to a Kafka topic for further processing.
Supported file transfer protocols are:
* SFTP
-
* FTPES
-
* HTTP
-
* HTTPS
@@ -67,7 +61,7 @@
"name":"A20220418.1900-1915_seliitdus00487.xml",
"hashMap":{
"fileFormatType":"org.3GPP.32.435#measCollec",
- "location":"https://launchpad.net/ubuntu/+source/perf-tools-unstable/1.0+git7ffb3fd-1ubuntu1/+build/13630748/+files/perf-tools-unstable_1.0+git7ffb3fd-1ubuntu1_all.deb",
+ "location":"https://gnb1.myran.org/pmfiles/",
"fileFormatVersion":"V10",
"compression":"gzip"
}