From 23dd15c7d2086b6edf06469c7d585772b6718351 Mon Sep 17 00:00:00 2001 From: yxpoke Date: Thu, 27 Apr 2023 18:12:24 +0800 Subject: Complete preliminary documentation for M4 Issue-ID: MODELING-668 Signed-off-by: yxpoke Change-Id: I786c2f5ceec0c89497b8b66a43f1fbcfde64ffcd --- .readthedocs.yaml | 3 ++ docs/ONAP Model Spec/dm/NodeTypes.rst | 2 +- docs/ONAP Model Spec/im/NSD/NSD.rst | 2 +- .../im/Service/ServiceModel-Service order.rst | 2 +- docs/Release-notes/release-notes.rst | 60 +++++++++++++++++++++- docs/tox.ini | 22 ++++---- 6 files changed, 78 insertions(+), 13 deletions(-) diff --git a/.readthedocs.yaml b/.readthedocs.yaml index 3797dc8..1f9776e 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -16,5 +16,8 @@ python: install: - requirements: docs/requirements-docs.txt +submodules: + include: all + sphinx: configuration: docs/conf.py diff --git a/docs/ONAP Model Spec/dm/NodeTypes.rst b/docs/ONAP Model Spec/dm/NodeTypes.rst index bdbdce5..bf8dcb9 100644 --- a/docs/ONAP Model Spec/dm/NodeTypes.rst +++ b/docs/ONAP Model Spec/dm/NodeTypes.rst @@ -10,7 +10,7 @@ Node Types | properties: | #id: | # node name -| name: # align with the IM, please refer to https://wiki.onap.org/display/DW/Design+Time+Model+Clean+Version#DesignTimeModelCleanVersion-Class:VDU/VDUDesc +| name: # align with the IM, please refer to https://wiki.onap.org/display/DW/Design+Time+Model+Clean+Version#DesignTimeModelCleanVersion-Class:Vdu | type: string | required: true | description: diff --git a/docs/ONAP Model Spec/im/NSD/NSD.rst b/docs/ONAP Model Spec/im/NSD/NSD.rst index f8ce8df..4cb3351 100644 --- a/docs/ONAP Model Spec/im/NSD/NSD.rst +++ b/docs/ONAP Model Spec/im/NSD/NSD.rst @@ -685,4 +685,4 @@ Contains Enumeration Literals: - LEVEL_3: -.. |image0| image:: NSD1.PNG +.. |image0| image:: NSD.png diff --git a/docs/ONAP Model Spec/im/Service/ServiceModel-Service order.rst b/docs/ONAP Model Spec/im/Service/ServiceModel-Service order.rst index c817884..7be1567 100644 --- a/docs/ONAP Model Spec/im/Service/ServiceModel-Service order.rst +++ b/docs/ONAP Model Spec/im/Service/ServiceModel-Service order.rst @@ -392,4 +392,4 @@ Contains Enumeration Literals: - REJECTED: -.. |image0| image:: ServiceOrderR4.png +.. |image0| image:: ServiceOrder.png diff --git a/docs/Release-notes/release-notes.rst b/docs/Release-notes/release-notes.rst index 4b23a49..58b7fff 100644 --- a/docs/Release-notes/release-notes.rst +++ b/docs/Release-notes/release-notes.rst @@ -7,8 +7,66 @@ Modeling Spec Release Notes =========================== +Version: 12.0.0 +--------------- + +:Release Date: 2023-4-26 + +**New Features** + None + +**Bug Fixes** + None + +**Security Notes** + +Modeling code has been formally scanned during build time using NexusIQ and no +Critical vulnerability was found. + +Quick Links: +- `Modeling project page `_ +- `Passing Badge information for Modeling `_ + +**Known Issues** + None + +**Upgrade Notes** + None + +**Other** + None + +Version: 11.0.0 +--------------- + +:Release Date: 2022-12-16 + +**New Features** + New Information Model for General Intent Model + +**Bug Fixes** + None + +**Security Notes** + +Modeling code has been formally scanned during build time using NexusIQ and no +Critical vulnerability was found. + +Quick Links: +- `Modeling project page `_ +- `Passing Badge information for Modeling `_ + +**Known Issues** + None + +**Upgrade Notes** + None + +**Other** + None + Version: 10.0.0 --------------- +--------------- :Release Date: 2022-6-24 diff --git a/docs/tox.ini b/docs/tox.ini index ce98799..8fc31ba 100644 --- 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,21 +8,25 @@ 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 + sphinx-build -W -q -b html -n -d {envtmpdir}/doctrees ./ {toxinidir}/_build/html +allowlist_externals = git sh [testenv:docs-linkcheck] -basepython = python3 +basepython = python3.8 #deps = -r{toxinidir}/requirements-docs.txt -commands = echo "Link Checking not enforced" +#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 +#allowlist_externals = echo [testenv:docs-spellcheck] basepython = python3.8 -- cgit 1.2.3-korg