Fix doc configuration on master branch

Signed-off-by: MichaelMorris <michael.morris@est.tech>
Issue-ID: SDC-4242
Change-Id: Iae21bb2ea386a78d53fd188121e83ab9ddba1bff

diff --git a/docs/conf.py b/docs/conf.py
index bd96005..6c81753 100644 (file)
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -1,8 +1,46 @@
-from docs_conf.conf import *
+project = "onap"
+release = "master"
+version = "master"
 
-master_doc = 'index'
+author = "Open Network Automation Platform"
+# yamllint disable-line rule:line-length
+copyright = "ONAP. Licensed under Creative Commons Attribution 4.0 International License"
+
+pygments_style = "sphinx"
+html_theme = "sphinx_rtd_theme"
+html_theme_options = {
+  "style_nav_header_background": "white",
+  "sticky_navigation": "False" }
+html_logo = "_static/logo_onap_2017.png"
+html_favicon = "_static/favicon.ico"
+html_static_path = ["_static"]
+html_show_sphinx = False
+
+extensions = [
+    'sphinx.ext.intersphinx',
+    'sphinx.ext.graphviz',
+    'sphinxcontrib.blockdiag',
+    'sphinxcontrib.seqdiag',
+    'sphinxcontrib.swaggerdoc',
+    'sphinxcontrib.plantuml'
+]
+
+#
+# Map to 'latest' if this file is used in 'latest' (master) 'doc' branch.
+# Change to {releasename} after you have created the new 'doc' branch.
+#
+
+branch = 'latest'
 
 intersphinx_mapping = {}
+doc_url = 'https://docs.onap.org/projects'
+master_doc = 'index'
+
+exclude_patterns = ['.tox']
+
+spelling_lang = "en_GB"
+spelling_word_list_filename='spelling_wordlist.txt'
+spelling_exclude_patterns=['release-notes.rst']
 
 linkcheck_ignore = [
     'http://localhost',

diff --git a/docs/externaltesting.rst b/docs/externaltesting.rst
index 3787ddb..bff1fbe 100644 (file)
--- a/docs/externaltesting.rst
+++ b/docs/externaltesting.rst
@@ -36,10 +36,10 @@ in this package:
   
   package: api/openecomp-sdc-rest-webapp/externaltesting-rest/externaltesting-rest-services
   
-Code to hold data types for the VTP API and the implemation of the interface to VTP is contained
+Code to hold data types for the VTP API and the implementation of the interface to VTP is contained
 in these packages:
 
-Provide the API and serialization classes for the REST API to VTP
+Provide the API and serialisation classes for the REST API to VTP
 
   package: lib/openecomp-sdc-externaltesting-lib/openecomp-sdc-externaltesting-api
   

diff --git a/docs/humaninterfaces.rst b/docs/humaninterfaces.rst
index 4a89d11..d7444bf 100644 (file)
--- a/docs/humaninterfaces.rst
+++ b/docs/humaninterfaces.rst
@@ -11,5 +11,3 @@ 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 <onap-doc:doc_guide_user_des>`
-

diff --git a/docs/logging.rst b/docs/logging.rst
index 7475362..777068b 100644 (file)
--- a/docs/logging.rst
+++ b/docs/logging.rst
@@ -9,7 +9,7 @@ Where to Access Information
 ---------------------------
 The logs for the application are available in the docker itself at /var/lib/jetty/logs/
 In Heat deployment the dockers are mapped into /data/logs on the vm where the application is running.
-In OOM you can use the logging project to access the loggings collected from the applications.
+In OOM you can use the logging project to access the logs collected from the applications.
 
 In the OOM deployment the log location in the docker is /var/log/onap
 

diff --git a/docs/onboardingpackages.rst b/docs/onboardingpackages.rst
index 60f37e9..f6d1cbf 100644 (file)
--- a/docs/onboardingpackages.rst
+++ b/docs/onboardingpackages.rst
@@ -16,9 +16,7 @@ SDC supports the following packages types
 - ETSI SOL004 Tosca CSAR Package
 - 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 <onap-doc:doc_guide_user_des>`
-
+For an extensive guide on how to perform onboarding, please refer to the ONAP User guide
 
 Heat Package
 ^^^^^^^^^^^^
@@ -29,7 +27,7 @@ There must be at least one heat template yaml file in the package whose name sta
 templates in the package can have any name. All  environment files that are included in the package must have the same
 name as its corresponding yaml file with a .env file extension.
 
-An example of a simple heat package stucture is a zip archive containing the following 3 files
+An example of a simple heat package structure is a zip archive containing the following 3 files
 
 - base_vFW.yaml   (heat template)
 - base_vFW.env    (corresponding environment file)
@@ -63,7 +61,7 @@ The supported descriptor included in the package is aligned to `ETSI NFV-SOL 001
 If the package is onboarded using the ETSI SOL001 v2.5.1 model, the structure of the supported CSAR package
 is as described in `ETSI NFV-SOL 004v2.5.1`_ csar structure option 1 i.e. CSAR containing a TOSCA-Metadata directory.
 
-The supported descriptor included in the package is aligned to `ETSI NFV-SOL 001v2.5.1`_. The tosca types defined in this version of the ETSI NFV-SOL 001 are used in the created VF (rather than the types defined in the SDC AID model).
+The supported descriptor included in the package is aligned to `ETSI NFV-SOL 001v2.5.1`_. The TOSCA types defined in this version of the ETSI NFV-SOL 001 are used in the created VF (rather than the types defined in the SDC AID model).
 
 Note in relation to model selection:
 
@@ -137,7 +135,7 @@ If the package extension is *.csar* and the following is true
 
 - CSAR package contains TOSCA-Metadata directory
 - The TOSCA.meta file exists within the TOSCA-Metadata directory
-- The TOSCA.meta file contains the following keynames in block_0
+- The TOSCA.meta file contains the following key names in block_0
 
    - Entry-Definitions
    - ETSI-Entry-Manifest
@@ -168,7 +166,7 @@ SDC supports the signature in Cryptographic Message Syntax (CMS) format.
 
 .. note::
    For SDC to validate the authenticity and integrity of the onboarding package, the root certificate of the trusted CA
-   needs to be pre-installed in SDC before onboarding is started. The details of this procedure are described :ref:`here <doc_guide_user_des_res-onb_pre-install_root_certificate>`.
+   needs to be pre-installed in SDC before onboarding is started.
 
 .. _ETSI NFV-SOL 004v2.6.1: https://docbox.etsi.org/ISG/NFV/Open/Publications_pdf/Specs-Reports/NFV-SOL%20004v2.6.1%20-%20GS%20-%20VNF%20Package%20Stage%203%20-%20spec.pdf
 .. _ETSI NFV-SOL 004v2.5.1: https://docbox.etsi.org/ISG/NFV/Open/Publications_pdf/Specs-Reports/NFV-SOL%20004v2.5.1%20-%20GS%20-%20VNF%20Package%20Stage%203%20spec.pdf

diff --git a/docs/release-notes.rst b/docs/release-notes.rst
index 0a3ea11..06f5c8f 100644 (file)
--- a/docs/release-notes.rst
+++ b/docs/release-notes.rst
@@ -6,7 +6,7 @@ Release Notes
 =============
 
 Version: 1.12.0
-==============
+===============
 
 :Release Date: 2022-10-28
 
@@ -111,7 +111,7 @@ Quick Links:
     N/A
 
 Version: 1.11.9
-==============
+===============
 
 :Release Date: 2022-09-28
 
@@ -201,7 +201,7 @@ Quick Links:
     N/A
 
 Version: 1.11.8
-==============
+===============
 
 :Release Date: 2022-09-09
 
@@ -301,7 +301,7 @@ Quick Links:
     N/A
 
 Version: 1.11.7
-==============
+===============
 
 :Release Date: 2022-08-15
 
@@ -396,7 +396,7 @@ Quick Links:
     N/A
 
 Version: 1.11.6
-==============
+===============
 
 :Release Date: 2022-07-21
 
@@ -487,7 +487,7 @@ Quick Links:
     N/A
 
 Version: 1.11.5
-==============
+===============
 
 :Release Date: 2022-06-24
 
@@ -577,7 +577,7 @@ Quick Links:
     N/A
 
 Version: 1.11.4
-==============
+===============
 
 :Release Date: 2022-06-09
 
@@ -668,7 +668,7 @@ Quick Links:
     N/A
 
 Version: 1.11.3
-==============
+===============
 
 :Release Date: 2022-05-17
 
@@ -751,7 +751,7 @@ Quick Links:
     N/A
 
 Version: 1.11.2
-==============
+===============
 
 :Release Date: 2022-04-23
 
@@ -840,7 +840,7 @@ Quick Links:
     N/A
 
 Version: 1.11.1
-==============
+===============
 
 :Release Date: 2022-04-08
 
@@ -911,7 +911,7 @@ Quick Links:
     N/A
 
 Version: 1.11.0
-==============
+===============
 
 :Release Date: 2022-04-05
 
@@ -994,7 +994,7 @@ Quick Links:
 
 
 Version: 1.10.3
-==============
+===============
 
 :Release Date: 2022-03-22
 
@@ -1067,7 +1067,7 @@ Quick Links:
     N/A
 
 Version: 1.10.2
-==============
+===============
 
 :Release Date: 2022-03-15
 
@@ -1096,10 +1096,10 @@ SDC Jakarta
 *  `SDC-3861 <https://jira.onap.org/browse/SDC-3861>`_ - Support for multiple directives
 *  `SDC-3898 <https://jira.onap.org/browse/SDC-3898>`_ - Support properties of type List<Map<String, String>>
 *  `SDC-3891 <https://jira.onap.org/browse/SDC-3891>`_ - Update SDC for rename of TOSCA CL to ACM
-*  `SDC-3891 <https://jira.onap.org/browse/SDC-3882>`_ - Support occurrences on node templates
-*  `SDC-3891 <https://jira.onap.org/browse/SDC-3897>`_ - Support complex types in interface operation inputs
-*  `SDC-3891 <https://jira.onap.org/browse/SDC-3899>`_ - Support complex types for artifact properties in interface operation implementation
-*  `SDC-3891 <https://jira.onap.org/browse/SDC-3887>`_ - Support instance count on node template
+*  `SDC-3882 <https://jira.onap.org/browse/SDC-3882>`_ - Support occurrences on node templates
+*  `SDC-3897 <https://jira.onap.org/browse/SDC-3897>`_ - Support complex types in interface operation inputs
+*  `SDC-3899 <https://jira.onap.org/browse/SDC-3899>`_ - Support complex types for artifact properties in interface operation implementation
+*  `SDC-3887 <https://jira.onap.org/browse/SDC-3887>`_ - Support instance count on node template
 
 **Bug Fixes**
 
@@ -1108,9 +1108,9 @@ SDC Jakarta
 *  `SDC-3889 <https://jira.onap.org/browse/SDC-3889>`_ - Error when no derived from exists
 *  `SDC-3888 <https://jira.onap.org/browse/SDC-3888>`_ - VSP upload with large files can handle the upload status incorrectly
 *  `SDC-3901 <https://jira.onap.org/browse/SDC-3901>`_ - Cannot create node filter capability if capability has different type properties
-*  `SDC-3901 <https://jira.onap.org/browse/SDC-3907>`_ - Exception when mouse over and out the node pallet in the composition screen
-*  `SDC-3901 <https://jira.onap.org/browse/SDC-3905>`_ - Error updating node filter capability
-*  `SDC-3901 <https://jira.onap.org/browse/SDC-3904>`_ - Error creating node filter capability using get_property
+*  `SDC-3907 <https://jira.onap.org/browse/SDC-3907>`_ - Exception when mouse over and out the node pallet in the composition screen
+*  `SDC-3905 <https://jira.onap.org/browse/SDC-3905>`_ - Error updating node filter capability
+*  `SDC-3904 <https://jira.onap.org/browse/SDC-3904>`_ - Error creating node filter capability using get_property
 
 **Tasks**
 
@@ -1154,7 +1154,7 @@ Quick Links:
     N/A
 
 Version: 1.10.1
-==============
+===============
 
 :Release Date: 2022-02-02
 
@@ -1200,7 +1200,7 @@ SDC Jakarta
 *  `SDC-3851 <https://jira.onap.org/browse/SDC-3851>`_ - Decrypt errors in sdc-be logs
 *  `SDC-3852 <https://jira.onap.org/browse/SDC-3852>`_ - Cassandra init dockers not working with latest version of cqlsh
 *  `SDC-2902 <https://jira.onap.org/browse/SDC-2902>`_ - Make sure Optionals values are defined before calling their `get` method
-*  `SDC-3837 <https://jira.onap.org/browse/SDC-3840>`_ - Remove test-jar generation
+*  `SDC-3840 <https://jira.onap.org/browse/SDC-3840>`_ - Remove test-jar generation
 
 
 **Tasks**
@@ -1244,7 +1244,7 @@ Quick Links:
 
 
 Version: 1.10.0
-==============
+===============
 
 :Release Date: 2022-01-07
 
@@ -1392,7 +1392,7 @@ SDC Istanbul Release
 
 **Stories**
 
-The full list of implemented stories is available on `JIRA ISTANBUL TASKS <https://jira.onap.org/issues/?jql=project%20%3D%20SDC%20AND%20issuetype%20%3D%20story%20AND%20fixVersion%20%3D%20%22Istanbul%20Release%22>`_
+The full list of implemented stories is available on `JIRA ISTANBUL STORIES <https://jira.onap.org/issues/?jql=project%20%3D%20SDC%20AND%20issuetype%20%3D%20story%20AND%20fixVersion%20%3D%20%22Istanbul%20Release%22>`_
 
 **Tasks**
 
@@ -2262,7 +2262,7 @@ The main goal of the Beijing release was to:
     - improve code coverage of the SDC code.
     - SDC introduced two new experimental projects the DCAE-D and WorkFlow which enhance the modeling capabilities of SDC.
 
-DCAE-D information is available here: `DCAE-DS <https://wiki.onap.org/display/DW/SDC-DCAE-D>`_
+DCAE-D information is available here: `DCAE-DS <https://wiki.onap.org/pages/viewpage.action?pageId=16005787>`_
 Workflow information is available in readthedocs
 
 **Epics**

diff --git a/docs/requirements-docs.txt b/docs/requirements-docs.txt
index 3b3441a..71df2ab 100644 (file)
--- a/docs/requirements-docs.txt
+++ b/docs/requirements-docs.txt
@@ -1,3 +1,7 @@
-lfdocs-conf
 sphinx>=4.2.0  # BSD
 sphinx-rtd-theme>=1.0.0  # MIT
+sphinxcontrib-blockdiag  # BSD
+sphinxcontrib-seqdiag # BSD
+sphinxcontrib-swaggerdoc
+sphinxcontrib-spelling
+sphinxcontrib-plantuml

diff --git a/docs/sdc-helm-validator.rst b/docs/sdc-helm-validator.rst
index cb4c85f..a66b7b7 100644 (file)
--- a/docs/sdc-helm-validator.rst
+++ b/docs/sdc-helm-validator.rst
@@ -20,10 +20,7 @@ More information could be found in project repository, see :ref:`sdc_helm_valida
 Offered API
 -----------
 
-.. Latest Open API model: :download:`OpenAPI.yaml <https://gerrit.onap.org/r/gitweb?p=sdc/sdc-helm-validator.git;a=blob_plain;f=OpenAPI.yaml;hb=refs/heads/master>`
-
-
-Latest Open API model: |sdc-helm-validator-open-api|_
+Latest Open API model: :download:`OpenAPI.yaml <https://gerrit.onap.org/r/gitweb?p=sdc/sdc-helm-validator.git;a=blob_plain;f=OpenAPI.yaml;hb=refs/heads/master>` 
 
 
 Validation

diff --git a/docs/spelling_wordlist.txt b/docs/spelling_wordlist.txt
new file mode 100644 (file)
index 0000000..14ef458
--- /dev/null
+++ b/docs/spelling_wordlist.txt
@@ -0,0 +1,83 @@
+Kohn
+init
+json
+Backend
+Catalog
+yaml
+janusgraph
+Onboarding
+externaltesting
+vnfrepo
+Frontend
+onboarding
+onapapi
+vnfsdk
+PackageResource
+csars
+csar
+vtp
+testsuites
+testSuiteName
+testcases
+testCaseName
+sdc
+cassandra
+Externalized
+onboarded
+subprojects
+openecomp
+api
+webapp
+impl
+xml
+src
+backend
+catalog
+frontend
+validator
+trift
+async
+http
+vm
+feproxy
+Guilin
+Pluggable
+onap
+stderrout
+logback
+config
+fe
+artifactArtifact
+Env
+artifact
+artifacts
+lifecycle
+serviceresource
+url
+VNF
+ENV
+MURANO
+boolean
+env
+uniqueId
+Artifact
+req
+forcap
+innerType
+adapters
+runtime
+xNF
+mano
+tgz
+pnfd
+Cryptographic
+pre
+vFW
+readme
+Deployable
+versionDesired
+vX
+isLinted
+isStrictLinted
+tosca
+jtosca

diff --git a/docs/tox.ini b/docs/tox.ini
index 49bbe01..b9d7eb4 100644 (file)
--- a/docs/tox.ini
+++ b/docs/tox.ini
@@ -1,6 +1,6 @@
 [tox]
 minversion = 1.6
-envlist = docs,
+envlist = docs,docs-linkcheck,docs-spellcheck
 skipsdist = true
 
 [testenv:docs]
@@ -8,18 +8,24 @@ basepython = python3.8
 deps =
     -r{toxinidir}/requirements-docs.txt
     -chttps://raw.githubusercontent.com/openstack/requirements/stable/yoga/upper-constraints.txt
-    -chttps://git.onap.org/doc/plain/etc/upper-constraints.onap.txt
+    -chttps://git.onap.org/doc/plain/etc/upper-constraints.onap.txt?h=master
 commands =
-    sphinx-build -b html -n -d {envtmpdir}/doctrees ./ {toxinidir}/_build/html
-    echo "Generated docs available in {toxinidir}/_build/html"
-whitelist_externals =
-    echo
-    git
-    sh
+    sphinx-build -W -q -b html -n -d {envtmpdir}/doctrees {toxinidir} {toxinidir}/_build/html
 
 [testenv:docs-linkcheck]
 basepython = python3.8
-#deps = -r{toxinidir}/requirements-docs.txt
-commands = echo "Link Checking not enforced"
-#commands = sphinx-build -b linkcheck -d {envtmpdir}/doctrees ./ {toxinidir}/_build/linkcheck
-whitelist_externals = echo
+deps =
+    -r{toxinidir}/requirements-docs.txt
+    -chttps://raw.githubusercontent.com/openstack/requirements/stable/yoga/upper-constraints.txt
+    -chttps://git.onap.org/doc/plain/etc/upper-constraints.onap.txt?h=master
+commands =
+    sphinx-build -W -q -b linkcheck -d {envtmpdir}/doctrees {toxinidir} {toxinidir}/_build/linkcheck
+
+[testenv:docs-spellcheck]
+basepython = python3.8
+deps =
+    -r{toxinidir}/requirements-docs.txt
+    -chttps://raw.githubusercontent.com/openstack/requirements/stable/yoga/upper-constraints.txt
+    -chttps://git.onap.org/doc/plain/etc/upper-constraints.onap.txt?h=master
+commands =
+    sphinx-build -W -q -b spelling -d {envtmpdir}/doctrees {toxinidir} {toxinidir}/_build/spellcheck