summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorChrisC <christophe.closset@intl.att.com>2020-11-17 11:35:34 +0100
committerS�bastien Determe <sebastien.determe@intl.att.com>2020-11-18 06:29:49 +0000
commit295b20c6d3d936099d6d2d8c434a6a8575d39c4a (patch)
tree99aef92817cdbf9a8b71cd295dfcd7fffd12fbfa
parent2f74a4ac81f228bdb0bf0f509e9c0ef296d28d82 (diff)
Fix doc issues
Update links Issue-ID: SDC-3370 Signed-off-by: ChrisC <christophe.closset@intl.att.com> Change-Id: I3c0c019c25286f78f0cf1e9a5e7d12390e706a2c
-rw-r--r--docs/conf.py3
-rw-r--r--docs/humaninterfaces.rst2
-rw-r--r--docs/index.rst2
-rw-r--r--docs/onboardingpackages.rst4
4 files changed, 8 insertions, 3 deletions
diff --git a/docs/conf.py b/docs/conf.py
index 5371015c66..4b24057691 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -1,6 +1,7 @@
from docs_conf.conf import *
branch = 'latest'
+doc_onap_url = 'https://docs.onap.org'
master_doc = 'index'
linkcheck_ignore = [
@@ -9,6 +10,8 @@ linkcheck_ignore = [
intersphinx_mapping = {}
+intersphinx_mapping['onap-doc'] = ('{}/en/%s'.format(doc_onap_url) % branch, None)
+
html_last_updated_fmt = '%d-%b-%y %H:%M'
def setup(app):
diff --git a/docs/humaninterfaces.rst b/docs/humaninterfaces.rst
index 3c3a78f1db..4a89d118c2 100644
--- a/docs/humaninterfaces.rst
+++ b/docs/humaninterfaces.rst
@@ -11,5 +11,5 @@ User Guides In ONAP Confluence
These are links to the SDC user guides found in ONAP User Guides:
* :ref:`sdc_onboarding_package_types`
-* :ref:`User Guides <user-guides>`
+* :ref:`User Guides <onap-doc:doc_guide_user_des>`
diff --git a/docs/index.rst b/docs/index.rst
index 20e3816934..e1aa94997b 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -15,6 +15,8 @@ SDC Documentation
delivery.rst
humaninterfaces.rst
genericdesignerintegration.rst
+ onboardingpackages.rst
+ externaltesting.rst
installation.rst
logging.rst
release-notes.rst
diff --git a/docs/onboardingpackages.rst b/docs/onboardingpackages.rst
index 7eb6ad1220..63bc152df4 100644
--- a/docs/onboardingpackages.rst
+++ b/docs/onboardingpackages.rst
@@ -17,7 +17,7 @@ SDC supports the following packages types
- Basic Helm package support for CNF
For an extensive guide on how to perform onboarding, please refer to the ONAP User guide:
-* :ref:`User Guides <user-guides>`
+* :ref:`User Guides <onap-doc:doc_guide_user_des>`
Heat Package
@@ -56,7 +56,7 @@ Other Points to note when onboarding this package are:
- The non-mano artifacts are mapped to the corresponding SDC Artifact Type in the xNF internal model.
Basic Helm package support for CNF
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
The helm package support is new since Guilin release, helm chart packaged as tgz file can be onboarded and distributed.
The support is limited for this first release.