diff options
| -rw-r--r-- | docs/conf.py | 3 | ||||
| -rw-r--r-- | docs/release-notes.rst | 39 | ||||
| -rw-r--r-- | docs/requirements-docs.txt | 15 | ||||
| -rw-r--r-- | docs/tox.ini | 22 | ||||
| -rw-r--r-- | requirements.txt | 4 | ||||
| -rw-r--r-- | tox.ini | 77 |
6 files changed, 100 insertions, 60 deletions
diff --git a/docs/conf.py b/docs/conf.py index 5371015..13d37b9 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -11,5 +11,6 @@ intersphinx_mapping = {} html_last_updated_fmt = '%d-%b-%y %H:%M' + def setup(app): - app.add_stylesheet("css/ribbon.css") + app.add_css_file("css/ribbon.css") diff --git a/docs/release-notes.rst b/docs/release-notes.rst index ee323f9..d2c80f2 100644 --- a/docs/release-notes.rst +++ b/docs/release-notes.rst @@ -35,9 +35,9 @@ N/A HOLMES code has been formally scanned during build time using NexusCloud and all critical vulnerabilities have been addressed. Quick Links: - - `HOLMES project page <https://wiki.onap.org/display/DW/Holmes+Project>`_ - - `Passing Badge information for HOLMES <https://bestpractices.coreinfrastructure.org/en/projects/1602>`_ +- `HOLMES project page <https://wiki.onap.org/display/DW/Holmes+Project>`_ +- `Passing Badge information for HOLMES <https://bestpractices.coreinfrastructure.org/en/projects/1602>`_ **Upgrade Notes** @@ -78,9 +78,9 @@ N/A HOLMES code has been formally scanned during build time using NexusCloud and all critical vulnerabilities have been addressed. Quick Links: - - `HOLMES project page <https://wiki.onap.org/display/DW/Holmes+Project>`_ - - `Passing Badge information for HOLMES <https://bestpractices.coreinfrastructure.org/en/projects/1602>`_ +- `HOLMES project page <https://wiki.onap.org/display/DW/Holmes+Project>`_ +- `Passing Badge information for HOLMES <https://bestpractices.coreinfrastructure.org/en/projects/1602>`_ **Upgrade Notes** @@ -123,9 +123,9 @@ Version: 7.0.1 HOLMES code has been formally scanned during build time using NexusCloud and all critical vulnerabilities have been addressed. Quick Links: - - `HOLMES project page <https://wiki.onap.org/display/DW/Holmes+Project>`_ - - `Passing Badge information for HOLMES <https://bestpractices.coreinfrastructure.org/en/projects/1602>`_ +- `HOLMES project page <https://wiki.onap.org/display/DW/Holmes+Project>`_ +- `Passing Badge information for HOLMES <https://bestpractices.coreinfrastructure.org/en/projects/1602>`_ **Upgrade Notes** @@ -166,9 +166,9 @@ N/A HOLMES code has been formally scanned during build time using NexusIQ and all Critical vulnerabilities have been addressed, some of the items that remain open have been assessed for risk and determined to be false positive and the rest are planned to be resolved in the next release. Quick Links: - - `HOLMES project page <https://wiki.onap.org/display/DW/Holmes+Project>`_ - - `Passing Badge information for HOLMES <https://bestpractices.coreinfrastructure.org/en/projects/1602>`_ +- `HOLMES project page <https://wiki.onap.org/display/DW/Holmes+Project>`_ +- `Passing Badge information for HOLMES <https://bestpractices.coreinfrastructure.org/en/projects/1602>`_ **Upgrade Notes** @@ -212,9 +212,9 @@ Added some tools to support the extended CCVPN use case: HOLMES code has been formally scanned during build time using NexusIQ and all Critical vulnerabilities have been addressed, some of the items that remain open have been assessed for risk and determined to be false positive and the rest are planned to be resolved in the next release. Quick Links: - - `HOLMES project page <https://wiki.onap.org/display/DW/Holmes+Project>`_ - - `Passing Badge information for HOLMES <https://bestpractices.coreinfrastructure.org/en/projects/1602>`_ +- `HOLMES project page <https://wiki.onap.org/display/DW/Holmes+Project>`_ +- `Passing Badge information for HOLMES <https://bestpractices.coreinfrastructure.org/en/projects/1602>`_ **Upgrade Notes** @@ -259,14 +259,13 @@ Besides, Holmes has been enhanced to be CCVPN use case supportive. CCVPN related **Security Issues** -HOLMES code has been formally scanned during build time using NexusIQ and all Critical vulnerabilities have been addressed, items that remain open have been assessed for risk and determined to be false positive. The HOLMES open Critical security vulnerabilities and their risk assessment have been documented as part of the `project <https://wiki.onap.org/pages/viewpage.action?pageId=45298796>`_. +HOLMES code has been formally scanned during build time using NexusIQ and all Critical vulnerabilities have been addressed, items that remain open have been assessed for risk and determined to be false positive. The HOLMES open Critical security vulnerabilities and their risk assessment have been documented as part of the `project`_. Quick Links: - - `HOLMES project page <https://wiki.onap.org/display/DW/Holmes+Project>`_ - - `Passing Badge information for HOLMES <https://bestpractices.coreinfrastructure.org/en/projects/1602>`_ - - - `Project Vulnerability Review Table for HOLMES <https://wiki.onap.org/pages/viewpage.action?pageId=45298796>`_ +- `HOLMES project page <https://wiki.onap.org/display/DW/Holmes+Project>`_ +- `Passing Badge information for HOLMES <https://bestpractices.coreinfrastructure.org/en/projects/1602>`_ +- `Project Vulnerability Review Table for HOLMES`_ **Upgrade Notes** @@ -296,13 +295,11 @@ Version: 1.1.0 In the Beijing release, Holmes provides no more functionalites than the Amsterdam release. Its main features remains like follows: - `Rule Management <https://jira.onap.org/browse/HOLMES-4>`_ The feature provides interfaces for the users to create, query, update and delete rules. In this release, they are used along with the DCAE interfaces to accomplish the deployment (creation/update) of the control loop related rules. - - `Engine Management <https://jira.onap.org/browse/HOLMES-5>`_ The feature is not exposed to the end user directly. It's mainly used internally by Holmes as a container for the execution of rules. It provides interface for rule verification and deployment/un-deployment. Besides, Holmes has been enhanced to meet the platform maturity requirements. The enhancement mainly covers: - Scaling: Holmes supports horizontal scale-in/scale-out operations in case it is overloaded by too large amounts of data. - - Security: Holmes has updated all its APIs to support the HTTPS protocol. **Bug Fixes** @@ -319,11 +316,10 @@ N/A HOLMES code has been formally scanned during build time using NexusIQ and all Critical vulnerabilities have been addressed, items that remain open have been assessed for risk and determined to be false positive. The HOLMES open Critical security vulnerabilities and their risk assessment have been documented as part of the `project <https://wiki.onap.org/pages/viewpage.action?pageId=28378012>`_. Quick Links: - - `HOLMES project page <https://wiki.onap.org/display/DW/Holmes+Project>`_ - - `Passing Badge information for HOLMES <https://bestpractices.coreinfrastructure.org/en/projects/1602>`_ - - - `Project Vulnerability Review Table for HOLMES <https://wiki.onap.org/pages/viewpage.action?pageId=28378012>`_ +- `HOLMES project page <https://wiki.onap.org/display/DW/Holmes+Project>`_ +- `Passing Badge information for HOLMES <https://bestpractices.coreinfrastructure.org/en/projects/1602>`_ +- `Project Vulnerability Review Table for HOLMES <https://wiki.onap.org/pages/viewpage.action?pageId=28378012>`_ **Upgrade Notes** @@ -358,7 +354,6 @@ correlation analysis for the VoLTE scenario. To get us there, Holmes provides the following features: - `Rule Management <https://jira.onap.org/browse/HOLMES-4>`_ The feature provides interfaces for the users to create, query, update and delete rules. In this release, they are used along with the DCAE interfaces to accomplish the deployment (creation/update) of the control loop related rules. - - `Engine Management <https://jira.onap.org/browse/HOLMES-5>`_ The feature is not exposed to the end user directly. It's mainly used internally by Holmes as a container for the execution of rules. It provides interface for rule verification and deployment/un-deployment. **Bug Fixes** diff --git a/docs/requirements-docs.txt b/docs/requirements-docs.txt deleted file mode 100644 index b3188dd..0000000 --- a/docs/requirements-docs.txt +++ /dev/null @@ -1,15 +0,0 @@ -tox -Sphinx -doc8 -docutils -setuptools -six -sphinx_rtd_theme>=0.4.3 -sphinxcontrib-blockdiag -sphinxcontrib-needs>=0.2.3 -sphinxcontrib-nwdiag -sphinxcontrib-seqdiag -sphinxcontrib-swaggerdoc -sphinxcontrib-plantuml -sphinx_bootstrap_theme -lfdocs-conf diff --git a/docs/tox.ini b/docs/tox.ini deleted file mode 100644 index edac8c3..0000000 --- a/docs/tox.ini +++ /dev/null @@ -1,22 +0,0 @@ -[tox] -minversion = 1.6 -envlist = docs, -skipsdist = true - -[testenv:docs] -basepython = python3 -deps = -r{toxinidir}/requirements-docs.txt -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 - -[testenv:docs-linkcheck] -basepython = python3 -#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 diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 0000000..b6654e5 --- /dev/null +++ b/requirements.txt @@ -0,0 +1,4 @@ +lfdocs-conf +autopep8 +sphinxcontrib-spelling +pylint @@ -0,0 +1,77 @@ +[tox] +minversion = 1.6 +envlist = docs,docs-linkcheck +skipsdist = true + +[testenv:docs] +basepython = python3 +deps = + -r{toxinidir}/requirements.txt + -chttps://git.onap.org/doc/plain/etc/upper-constraints.os.txt + -chttps://git.onap.org/doc/plain/etc/upper-constraints.onap.txt +commands = + sphinx-build -W -q -b html -n -d {envtmpdir}/docs/doctrees {toxinidir}/docs {toxinidir}/docs/_build/html + echo "Generated docs available in {toxinidir}/docs/_build/html" +whitelist_externals = + echo + git + sh + +[testenv:docs-templates] +basepython = python3 +deps = + -r{toxinidir}/requirements.txt + -chttps://git.onap.org/doc/plain/etc/upper-constraints.os.txt + -chttps://git.onap.org/doc/plain/etc/upper-constraints.onap.txt +commands = + sphinx-build -b html -n -d {envtmpdir}/doctrees -c {toxinidir}/docs/ {toxinidir}/docs/guides/onap-developer/how-to-use-docs/templates {toxinidir}/_build/templates + echo "Generated docs available in {toxinidir}/_build/html/templates" +whitelist_externals = + echo + +[testenv:local] +basepython = python3 +deps = + -r{toxinidir}/requirements.txt + -chttps://git.onap.org/doc/plain/etc/upper-constraints.os.txt + -chttps://git.onap.org/doc/plain/etc/upper-constraints.onap.txt +commands = + git submodule update --depth 100 --init + sphinx-build -q -b html -n -d {envtmpdir}/doctrees {toxinidir}/docs {toxinidir}/docs/_build/html + echo "Generated docs available in {toxinidir}/docs/_build/html" +whitelist_externals = + echo + git + +[testenv:docs-linkcheck] +basepython = python3 +deps = + -r{toxinidir}/requirements.txt + -chttps://git.onap.org/doc/plain/etc/upper-constraints.os.txt + -chttps://git.onap.org/doc/plain/etc/upper-constraints.onap.txt +commands = sphinx-build -q -b linkcheck -d {envtmpdir}/doctrees {toxinidir}/docs {toxinidir}/docs/_build/linkcheck + +[testenv:spellcheck] +basepython = python3 +deps = + -r{toxinidir}/requirements.txt + -chttps://git.onap.org/doc/plain/etc/upper-constraints.os.txt + -chttps://git.onap.org/doc/plain/etc/upper-constraints.onap.txt +commands = + sphinx-build -b spelling -Dextensions=sphinxcontrib.spelling -d {envtmpdir}/doctrees {toxinidir} {toxinidir}/docs/_build/spellcheck + +[testenv:autopep8] +deps = + -r{toxinidir}/requirements.txt + -chttps://git.onap.org/doc/plain/etc/upper-constraints.os.txt + -chttps://git.onap.org/doc/plain/etc/upper-constraints.onap.txt +commands = + autopep8 --max-line-length 120 --in-place {toxinidir}/docs/conf.py + +[testenv:pylint] +deps = + -r{toxinidir}/requirements.txt + -chttps://git.onap.org/doc/plain/etc/upper-constraints.os.txt + -chttps://git.onap.org/doc/plain/etc/upper-constraints.onap.txt +commands = + pylint --max-line-length=120 --disable=missing-docstring --reports=y --score=y --output-format=colorized {toxinidir}/docs/conf.py |