From e473a3b625a8504f9fc62148e6d4159ec4e1cca9 Mon Sep 17 00:00:00 2001 From: ktimoney Date: Fri, 30 Jun 2023 12:21:24 +0100 Subject: [PATCH] Fix mistakes in docs. Issue-ID: NONRTRIC-887 Change-Id: I866224247c49430dde73eab457c8c0ca8f4bf9d5 Signed-off-by: ktimoney --- docs/developer-guide.rst | 6 ++---- docs/installation-guide.rst | 6 +++--- docs/requirements-docs.txt | 10 ++++++++++ nonrtric-gateway/README.md | 2 +- webapp-frontend/README.md | 1 + 5 files changed, 17 insertions(+), 8 deletions(-) diff --git a/docs/developer-guide.rst b/docs/developer-guide.rst index bd350c5..839b0e1 100644 --- a/docs/developer-guide.rst +++ b/docs/developer-guide.rst @@ -8,8 +8,7 @@ Developer Guide This document provides a quick start for developers of the Non-RT RIC Control Panel. The Non-RT RIC Control Panel is an interface that allows human users to create, edit and delete policy instances, for -each existing policy type. The policy types and their definitions are retrieved from each Near-RT RIC. It is also -possible to change the configuration of available RICs, provided that Consul is not used. +each existing policy type. The policy types and their definitions are retrieved from each Near-RT RIC. Additionally, producers and jobs for the Information coordinator service can be viewed. @@ -78,13 +77,12 @@ When the instances are listed, it is possible to edit or delete each instance fr .. image:: ./images/non-RT_RIC_controlpanel_Policy.PNG -It is also possible to manage the configuration of available RICs, provided that Consul is not used, from the Control Panel. From the menu on the left hand side, select "Policy -> RIC Config". .. image:: ./images/non-RT_RIC_controlpanel_ric_config.PNG -From the main page, click on the "Information information coordinator" card or use the menu on the left hand side of the page. +From the main page, click on the "Enrichment information coordinator" card or use the menu on the left hand side of the page. From here it is possible to view producers and jobs from the Information service, .. image:: ./images/non-RT_RIC_controlpanel_EI.PNG diff --git a/docs/installation-guide.rst b/docs/installation-guide.rst index fde64ba..bf843fc 100644 --- a/docs/installation-guide.rst +++ b/docs/installation-guide.rst @@ -49,9 +49,9 @@ Install with Helm +++++++++++++++++ Helm charts and an example recipe are provided in the `it/dep repo `__, -under "nonrtric". By modifying the variables named "installXXX" in the beginning of the example recipe file, which -components that will be installed can be controlled. Then the components can be installed and started by running the -following comand: +under "nonrtric". By modifying the variables named "installXXX" at the beginning of the example recipe file, the +components that will be installed can be controlled. The components can be then be installed and started by running the +following command: .. code-block:: bash diff --git a/docs/requirements-docs.txt b/docs/requirements-docs.txt index 09a0c1c..6c34f75 100644 --- a/docs/requirements-docs.txt +++ b/docs/requirements-docs.txt @@ -3,3 +3,13 @@ sphinx-rtd-theme sphinxcontrib-httpdomain recommonmark lfdocs-conf +tox +doc8 +docutils < 0.17 +setuptools +six +sphinxcontrib-needs +sphinxcontrib-swaggerdoc +sphinx_bootstrap_theme +sphinxcontrib-redoc +urllib3~=1.26.15 diff --git a/nonrtric-gateway/README.md b/nonrtric-gateway/README.md index 0b3535c..13f07b4 100644 --- a/nonrtric-gateway/README.md +++ b/nonrtric-gateway/README.md @@ -6,7 +6,7 @@ The application is a spring cloud gateway and all the route configurations are p ## License -Copyright (C) 2021 Nordix Foundation. All rights reserved. +Copyright (C) 2021-2023 Nordix Foundation. All rights reserved. Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at diff --git a/webapp-frontend/README.md b/webapp-frontend/README.md index 04e40fe..ce03d51 100644 --- a/webapp-frontend/README.md +++ b/webapp-frontend/README.md @@ -38,3 +38,4 @@ distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. + -- 2.16.6