diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/requirements-docs.txt | 16 | ||||
| -rw-r--r-- | docs/sections/release-notes.rst | 91 | ||||
| -rw-r--r-- | docs/tox.ini | 9 |
3 files changed, 98 insertions, 18 deletions
diff --git a/docs/requirements-docs.txt b/docs/requirements-docs.txt index 9c3391a..3b3441a 100644 --- a/docs/requirements-docs.txt +++ b/docs/requirements-docs.txt @@ -1,15 +1,3 @@ -tox -Sphinx -doc8 -docutils -setuptools -six -sphinx_rtd_theme>=0.4.3 -sphinxcontrib-blockdiag -sphinxcontrib-needs==0.5.6 -sphinxcontrib-nwdiag -sphinxcontrib-seqdiag -sphinxcontrib-swaggerdoc -sphinxcontrib-plantuml -sphinx_bootstrap_theme lfdocs-conf +sphinx>=4.2.0 # BSD +sphinx-rtd-theme>=1.0.0 # MIT diff --git a/docs/sections/release-notes.rst b/docs/sections/release-notes.rst index 7c1c68f..19d9b88 100644 --- a/docs/sections/release-notes.rst +++ b/docs/sections/release-notes.rst @@ -1,11 +1,100 @@ .. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. _release_notes: ============= Release Notes ============= + + +.. =========================== +.. * * * JAKARTA * * * +.. =========================== + +Abstract +======== + +This document provides the release notes for the JAKARTA release. + +Summary +======= + + +Release Data +============ + + ++--------------------------------------+--------------------------------------+ +| **OOF Project** | | +| | | ++--------------------------------------+--------------------------------------+ +| **Docker images** | optf-has 2.3.0 | +| | | +| | | ++--------------------------------------+--------------------------------------+ +| **Release designation** | 10.0.0 jakarta | +| | | ++--------------------------------------+--------------------------------------+ +| **Release date** | 02/06/2022 (TBD) | +| | | ++--------------------------------------+--------------------------------------+ + + +New features +------------ + +- Enhancements to support capacity based NSI/NSSI Selection for the Slicing usecase + + +Bug Fixes +--------- + +OPTFRA-1064 - Fix bug in fetching capacity attributes from DCAE + + +Known Limitations, Issues and Workarounds +========================================= + + +System Limitations +------------------ + + +Known Vulnerabilities +--------------------- + + +Workarounds +----------- + + +Security Notes +-------------- + + +References +========== + +For more information on the ONAP Jakarta release, please see: + +#. `ONAP Home Page`_ +#. `ONAP Documentation`_ +#. `ONAP Release Downloads`_ +#. `ONAP Wiki Page`_ + + +.. _`ONAP Home Page`: https://www.onap.org +.. _`ONAP Wiki Page`: https://wiki.onap.org +.. _`ONAP Documentation`: https://docs.onap.org +.. _`ONAP Release Downloads`: https://git.onap.org + +Quick Links: +- `OOF project page <https://wiki.onap.org/display/DW/Optimization+Framework+Project>`_ +- `Passing Badge information for OOF <https://bestpractices.coreinfrastructure.org/en/projects/1720>`_ + + .. =========================== .. * * * ISTANBUL * * * .. =========================== @@ -30,7 +119,7 @@ Release Data | **Docker images** | - optf-has 2.2.1 | | | | +--------------------------------------+--------------------------------------+ -| **Release designation** | 8.0.0 istanbul | +| **Release designation** | 9.0.0 istanbul | | | | +--------------------------------------+--------------------------------------+ | **Release date** | 28/10/2021 (TBD) | diff --git a/docs/tox.ini b/docs/tox.ini index edac8c3..49bbe01 100644 --- a/docs/tox.ini +++ b/docs/tox.ini @@ -4,8 +4,11 @@ envlist = docs, skipsdist = true [testenv:docs] -basepython = python3 -deps = -r{toxinidir}/requirements-docs.txt +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 commands = sphinx-build -b html -n -d {envtmpdir}/doctrees ./ {toxinidir}/_build/html echo "Generated docs available in {toxinidir}/_build/html" @@ -15,7 +18,7 @@ whitelist_externals = sh [testenv:docs-linkcheck] -basepython = python3 +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 |