summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorthmsdt <thomas.kulik@telekom.de>2024-02-20 14:08:27 +0100
committerMatthew Watkins <mwatkins@linuxfoundation.org>2024-02-26 15:02:19 +0000
commit8e8b2da28a996c4f33d60563fadbfdc4ab6b7fab (patch)
treee95024d3216cfe8bad70c3d1efb7df87c635dc67
parent8e5db002fc77a540af715c1934c5b318129cb821 (diff)
add python compatibility module
Issue-ID: DOC-823 Change-Id: If32f0c2b844280aeaa157ccb63dbc66ff82f14aa Signed-off-by: thmsdt <thomas.kulik@telekom.de>
-rw-r--r--docs/MultiCloud-Test-CSIT.rst2
-rw-r--r--docs/Release Notes.rst2
-rw-r--r--docs/conf.py6
-rw-r--r--docs/multicloud-hpa-discovery-pluggable.rst2
-rw-r--r--docs/release-notes.rst2
-rw-r--r--docs/requirements-docs.txt3
-rw-r--r--docs/specs/README.rst3
-rw-r--r--docs/specs/logging_enablement.rst8
-rw-r--r--docs/specs/multicloud-container-plugin.rst12
-rw-r--r--docs/specs/multicloud-secured-communication.rst2
-rw-r--r--docs/specs/multicloud4k8s-hpa-discovery.rst2
-rw-r--r--docs/specs/parallelism_improvement.rst2
12 files changed, 32 insertions, 14 deletions
diff --git a/docs/MultiCloud-Test-CSIT.rst b/docs/MultiCloud-Test-CSIT.rst
index 145148e..d0ecf65 100644
--- a/docs/MultiCloud-Test-CSIT.rst
+++ b/docs/MultiCloud-Test-CSIT.rst
@@ -2,6 +2,8 @@
This work is licensed under a Creative Commons Attribution 4.0
International License.
+:orphan:
+
===============================
ONAP MultiCloud CSIT Test Guide
===============================
diff --git a/docs/Release Notes.rst b/docs/Release Notes.rst
index 1306c13..f08eb5c 100644
--- a/docs/Release Notes.rst
+++ b/docs/Release Notes.rst
@@ -4,6 +4,8 @@
This work is licensed under a Creative Commons Attribution 4.0
International License.
+:orphan:
+
=============
Release Notes
=============
diff --git a/docs/conf.py b/docs/conf.py
index 667f168..2248321 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -52,5 +52,7 @@ def setup(app):
app.add_css_file("css/ribbon.css")
linkcheck_ignore = [
- r'http://localhost:\d+/'
-] \ No newline at end of file
+ r'http:\.*',
+ r'https:\.*'
+ r'\.*'
+]
diff --git a/docs/multicloud-hpa-discovery-pluggable.rst b/docs/multicloud-hpa-discovery-pluggable.rst
index ff330bb..8540bf3 100644
--- a/docs/multicloud-hpa-discovery-pluggable.rst
+++ b/docs/multicloud-hpa-discovery-pluggable.rst
@@ -2,6 +2,8 @@
.. http://creativecommons.org/licenses/by/4.0
.. Copyright (c) 2017-2018 VMware, Inc.
+:orphan:
+
==================================
MultiCloud HPA Discovery Pluggable
==================================
diff --git a/docs/release-notes.rst b/docs/release-notes.rst
index 927ca32..e0d3406 100644
--- a/docs/release-notes.rst
+++ b/docs/release-notes.rst
@@ -18,7 +18,7 @@ Summary
Version: 11.0.0
---------------
+---------------
There are no updates to the Multicloud project for the Kohn release
diff --git a/docs/requirements-docs.txt b/docs/requirements-docs.txt
index ba3e0ec..097282b 100644
--- a/docs/requirements-docs.txt
+++ b/docs/requirements-docs.txt
@@ -4,4 +4,5 @@ sphinxcontrib-blockdiag # BSD
sphinxcontrib-seqdiag # BSD
sphinxcontrib-swaggerdoc
sphinxcontrib-spelling
-sphinxcontrib-plantuml \ No newline at end of file
+sphinxcontrib-plantuml
+six
diff --git a/docs/specs/README.rst b/docs/specs/README.rst
index b39c8d3..28714fb 100644
--- a/docs/specs/README.rst
+++ b/docs/specs/README.rst
@@ -1,3 +1,6 @@
+
+:orphan:
+
INTRO
=====
diff --git a/docs/specs/logging_enablement.rst b/docs/specs/logging_enablement.rst
index 9f89443..4f4ac16 100644
--- a/docs/specs/logging_enablement.rst
+++ b/docs/specs/logging_enablement.rst
@@ -19,12 +19,12 @@ Problem Description
So far the logging of multi-vim is not able to support customer configuration,
handler context specific logging like
-MDC[MDC_Document]_, also it dose't propagate transaction-ID in REST headers
+MDC `MDC_Document`_ , also it dose't propagate transaction-ID in REST headers
which is critical to tracing request.
There are 4 python containers in oom project need to configure filebeat
container for shipping logs.
-.. [MDC_Document] https://wiki.onap.org/display/DW/ONAP+Application+Logging+Guidelines+v1.1#ONAPApplicationLoggingGuidelinesv1.1-MDCs
+.. _MDC_Document: https://wiki.onap.org/display/DW/ONAP+Application+Logging+Guidelines+v1.1#ONAPApplicationLoggingGuidelinesv1.1-MDCs
In addition the current logging is very difficult to understand behavior
and performance.
@@ -38,13 +38,13 @@ The proposed change will include three parts.
Filebeat container
------------------
-Logging architecture[Log_Architecture]_ use Filebeat collects logs from
+Logging architecture `Log_Architecture`_ use Filebeat collects logs from
multi-vim containers and ships them to the
centralized logging stack. To enable this feature it need to add Filebeat
container in multi-vim pod that was
deployed by OOM, as well Yaml file will be used to configure Filebeat.
-.. [Log_Architecture] https://wiki.onap.org/display/DW/Logging+Architecture
+.. _Log_Architecture: https://wiki.onap.org/display/DW/Logging+Architecture
Tracing ID
----------
diff --git a/docs/specs/multicloud-container-plugin.rst b/docs/specs/multicloud-container-plugin.rst
index 0c68a89..d7182cb 100644
--- a/docs/specs/multicloud-container-plugin.rst
+++ b/docs/specs/multicloud-container-plugin.rst
@@ -294,7 +294,7 @@ Request Body:
================== ========== ======= ========================================
There are several constraints/assumptions on cloudOwner and
-cloudRegionId. `cloud-region`_ . For k8s, cloudRegionId is (ab)used to
+cloudRegionId. For k8s, cloudRegionId is (ab)used to
specify k8s cluster instance. ONAP admin has to assign unique id for
cloudRegionId as id for k8s cluster instance.
@@ -571,9 +571,9 @@ Past presentations/proposals
ONAP components
---------------
-.. _ESR: Extenral System Register https://wiki.onap.org/pages/viewpage.action?pageId=11930343#A&AI:ExternalSystemOperationAPIDefinition-VIM
+.. _"ESR: External System Register" https://wiki.onap.org/pages/viewpage.action?pageId=11930343#A&AI:ExternalSystemOperationAPIDefinition-VIM
.. _AAI: Active and Available Inventory https://wiki.onap.org/display/DW/Active+and+Available+Inventory+Project
-.. _OOM: ONAP Operations Manager https://wiki.onap.org/display/DW/ONAP+Operations+Manager+Project
+.. _"OOM: ONAP Operations Manager" https://wiki.onap.org/display/DW/ONAP+Operations+Manager+Project
.. _ONAPREST: RESTful API Design Specification https://wiki.onap.org/display/DW/RESTful+API+Design+Specification
kubernetes
@@ -582,9 +582,9 @@ kubernetes
.. _issue23: https://github.com/kubernetes/kubeadm/issues/23
-misc
-----
-.. _cloud-region: How to add a new cloud region and some thoughts https://wiki.onap.org/download/attachments/25429038/HowToAddNewCloudRegionAndThoughts.pdf
+.. misc
+.. ----
+.. .. _cloud-region: How to add a new cloud region and some thoughts https://wiki.onap.org/download/attachments/25429038/HowToAddNewCloudRegionAndThoughts.pdf
Contributors
diff --git a/docs/specs/multicloud-secured-communication.rst b/docs/specs/multicloud-secured-communication.rst
index 722e86b..c12290f 100644
--- a/docs/specs/multicloud-secured-communication.rst
+++ b/docs/specs/multicloud-secured-communication.rst
@@ -2,6 +2,8 @@
This work is licensed under a Creative Commons Attribution 4.0
International License.
+:orphan:
+
======================================================
MultiCloud security enhancement: secured communication
======================================================
diff --git a/docs/specs/multicloud4k8s-hpa-discovery.rst b/docs/specs/multicloud4k8s-hpa-discovery.rst
index 4d90a8c..fccf9b5 100644
--- a/docs/specs/multicloud4k8s-hpa-discovery.rst
+++ b/docs/specs/multicloud4k8s-hpa-discovery.rst
@@ -2,6 +2,8 @@
.. http://creativecommons.org/licenses/by/4.0
.. Copyright (c) 2019 Intel, Inc.
+:orphan:
+
=================================================
MultiCloud for k8s HPA Discovery And Registration
=================================================
diff --git a/docs/specs/parallelism_improvement.rst b/docs/specs/parallelism_improvement.rst
index 69f0fb8..6ebece3 100644
--- a/docs/specs/parallelism_improvement.rst
+++ b/docs/specs/parallelism_improvement.rst
@@ -2,6 +2,8 @@
This work is licensed under a Creative Commons Attribution 4.0
International License.
+:orphan:
+
===============================================
Parallelism improvement of Multi Cloud Services
===============================================