diff options
| -rw-r--r-- | docs/conf.py | 62 | ||||
| -rw-r--r-- | docs/release-notes.rst | 33 | ||||
| -rw-r--r-- | docs/release/index.rst | 45 | ||||
| -rw-r--r-- | docs/spelling_wordlist.txt (renamed from docs/validwords.txt) | 10 | ||||
| -rw-r--r-- | etc/requirements.txt | 9 | ||||
| -rw-r--r-- | tox.ini | 12 |
6 files changed, 129 insertions, 42 deletions
diff --git a/docs/conf.py b/docs/conf.py index 296ef99b0..2de736ec9 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -1,3 +1,4 @@ +from docutils.parsers.rst import directives from docs_conf.conf import * branch = 'latest' @@ -10,47 +11,58 @@ linkcheck_ignore = [ intersphinx_mapping = {} -intersphinx_mapping['onap-oom-offline-installer'] = ('{}/onap-oom-offline-installer/en/%s'.format(doc_url) % branch, None) +intersphinx_mapping['onap-oom-offline-installer'] = ( + '{}/onap-oom-offline-installer/en/%s'.format(doc_url) % branch, None) intersphinx_mapping['onap-oom'] = ('{}/onap-oom/en/%s'.format(doc_url) % branch, None) intersphinx_mapping['onap-osa'] = ('{}/onap-osa/en/%s'.format(doc_url) % branch, None) intersphinx_mapping['onap-oparent-cia'] = ('{}/onap-oparent-cia/en/%s'.format(doc_url) % branch, None) -intersphinx_mapping['onap-music-distributed-kv-store'] = ('{}/onap-music-distributed-kv-store/en/%s'.format(doc_url) % branch, None) +intersphinx_mapping['onap-music-distributed-kv-store'] = ( + '{}/onap-music-distributed-kv-store/en/%s'.format(doc_url) % branch, None) intersphinx_mapping['onap-dmaap-dbcapi'] = ('{}/onap-dmaap-dbcapi/en/%s'.format(doc_url) % branch, None) intersphinx_mapping['onap-msb-swagger-sdk'] = ('{}/onap-msb-swagger-sdk/en/%s'.format(doc_url) % branch, None) intersphinx_mapping['onap-msb-java-sdk'] = ('{}/onap-msb-java-sdk/en/%s'.format(doc_url) % branch, None) -intersphinx_mapping['onap-holmes-engine-management'] = ('{}/onap-holmes-engine-management/en/%s'.format(doc_url) % branch, None) +intersphinx_mapping['onap-holmes-engine-management'] = ( + '{}/onap-holmes-engine-management/en/%s'.format(doc_url) % branch, None) intersphinx_mapping['onap-multicloud-azure'] = ('{}/onap-multicloud-azure/en/%s'.format(doc_url) % branch, None) intersphinx_mapping['onap-modeling-etsicatalog'] = ('{}/onap-modeling-etsicatalog/en/%s'.format(doc_url) % branch, None) -intersphinx_mapping['onap-modeling-toscaparsers'] = ('{}/onap-modeling-toscaparsers/en/%s'.format(doc_url) % branch, None) +intersphinx_mapping['onap-modeling-toscaparsers'] = ( + '{}/onap-modeling-toscaparsers/en/%s'.format(doc_url) % branch, None) intersphinx_mapping['onap-modeling-modelspec'] = ('{}/onap-modeling-modelspec/en/%s'.format(doc_url) % branch, None) intersphinx_mapping['onap-vnfrqts-requirements'] = ('{}/onap-vnfrqts-requirements/en/%s'.format(doc_url) % branch, None) intersphinx_mapping['onap-vnfrqts-guidelines'] = ('{}/onap-vnfrqts-guidelines/en/%s'.format(doc_url) % branch, None) -intersphinx_mapping['onap-dmaap-messagerouter-messageservice'] = ('{}/onap-dmaap-messagerouter-messageservice/en/%s'.format(doc_url) % branch, None) +intersphinx_mapping['onap-dmaap-messagerouter-messageservice'] = ( + '{}/onap-dmaap-messagerouter-messageservice/en/%s'.format(doc_url) % branch, None) intersphinx_mapping['onap-externalapi-nbi'] = ('{}/onap-externalapi-nbi/en/%s'.format(doc_url) % branch, None) intersphinx_mapping['onap-logging-analytics'] = ('{}/onap-logging-analytics/en/%s'.format(doc_url) % branch, None) intersphinx_mapping['onap-dmaap-buscontroller'] = ('{}/onap-dmaap-buscontroller/en/%s'.format(doc_url) % branch, None) intersphinx_mapping['onap-dmaap-datarouter'] = ('{}/onap-dmaap-datarouter/en/%s'.format(doc_url) % branch, None) intersphinx_mapping['onap-music'] = ('{}/onap-music/en/%s'.format(doc_url) % branch, None) -intersphinx_mapping['onap-sdc-sdc-workflow-designer'] = ('{}/onap-sdc-sdc-workflow-designer/en/%s'.format(doc_url) % branch, None) +intersphinx_mapping['onap-sdc-sdc-workflow-designer'] = ( + '{}/onap-sdc-sdc-workflow-designer/en/%s'.format(doc_url) % branch, None) intersphinx_mapping['onap-sdc-sdc-tosca'] = ('{}/onap-sdc-sdc-tosca/en/%s'.format(doc_url) % branch, None) intersphinx_mapping['onap-vvp-documentation'] = ('{}/onap-vvp-documentation/en/%s'.format(doc_url) % branch, None) -intersphinx_mapping['onap-logging-analytics-pomba-pomba-audit-common'] = ('{}/onap-logging-analytics-pomba-pomba-audit-common/en/%s'.format(doc_url) % branch, None) +intersphinx_mapping['onap-logging-analytics-pomba-pomba-audit-common'] = ( + '{}/onap-logging-analytics-pomba-pomba-audit-common/en/%s'.format(doc_url) % branch, None) intersphinx_mapping['onap-msb-apigateway'] = ('{}/onap-msb-apigateway/en/%s'.format(doc_url) % branch, None) intersphinx_mapping['onap-msb-discovery'] = ('{}/onap-msb-discovery/en/%s'.format(doc_url) % branch, None) intersphinx_mapping['onap-vnfrqts-testcases'] = ('{}/onap-vnfrqts-testcases/en/%s'.format(doc_url) % branch, None) intersphinx_mapping['onap-vnfrqts-usecases'] = ('{}/onap-vnfrqts-usecases/en/%s'.format(doc_url) % branch, None) intersphinx_mapping['onap-policy-parent'] = ('{}/onap-policy-parent/en/%s'.format(doc_url) % branch, None) intersphinx_mapping['onap-vfc-nfvo-lcm'] = ('{}/onap-vfc-nfvo-lcm/en/%s'.format(doc_url) % branch, None) -intersphinx_mapping['onap-vfc-nfvo-driver-vnfm-svnfm'] = ('{}/onap-vfc-nfvo-driver-vnfm-svnfm/en/%s'.format(doc_url) % branch, None) -intersphinx_mapping['onap-holmes-rule-management'] = ('{}/onap-holmes-rule-management/en/%s'.format(doc_url) % branch, None) +intersphinx_mapping['onap-vfc-nfvo-driver-vnfm-svnfm'] = ( + '{}/onap-vfc-nfvo-driver-vnfm-svnfm/en/%s'.format(doc_url) % branch, None) +intersphinx_mapping['onap-holmes-rule-management'] = ( + '{}/onap-holmes-rule-management/en/%s'.format(doc_url) % branch, None) intersphinx_mapping['onap-portal'] = ('{}/onap-portal/en/%s'.format(doc_url) % branch, None) intersphinx_mapping['onap-cli'] = ('{}/onap-cli/en/%s'.format(doc_url) % branch, None) -intersphinx_mapping['onap-oom-platform-cert-service'] = ('{}/onap-oom-platform-cert-service/en/%s'.format(doc_url) % branch, None) +intersphinx_mapping['onap-oom-platform-cert-service'] = ( + '{}/onap-oom-platform-cert-service/en/%s'.format(doc_url) % branch, None) intersphinx_mapping['onap-ccsdk-cds'] = ('{}/onap-ccsdk-cds/en/%s'.format(doc_url) % branch, None) intersphinx_mapping['onap-ccsdk-apps'] = ('{}/onap-ccsdk-apps/en/%s'.format(doc_url) % branch, None) intersphinx_mapping['onap-ccsdk-oran'] = ('{}/onap-ccsdk-oran/en/%s'.format(doc_url) % branch, None) intersphinx_mapping['onap-sdnc-oam'] = ('{}/onap-sdnc-oam/en/%s'.format(doc_url) % branch, None) -intersphinx_mapping['onap-ccsdk-platform-plugins'] = ('{}/onap-ccsdk-platform-plugins/en/%s'.format(doc_url) % branch, None) +intersphinx_mapping['onap-ccsdk-platform-plugins'] = ( + '{}/onap-ccsdk-platform-plugins/en/%s'.format(doc_url) % branch, None) intersphinx_mapping['onap-ccsdk-dashboard'] = ('{}/onap-ccsdk-dashboard/en/%s'.format(doc_url) % branch, None) intersphinx_mapping['onap-ccsdk-features'] = ('{}/onap-ccsdk-features/en/%s'.format(doc_url) % branch, None) intersphinx_mapping['onap-ccsdk-distribution'] = ('{}/onap-ccsdk-distribution/en/%s'.format(doc_url) % branch, None) @@ -64,7 +76,8 @@ intersphinx_mapping['onap-appc-deployment'] = ('{}/onap-appc-deployment/en/%s'.f intersphinx_mapping['onap-optf-cmso'] = ('{}/onap-optf-cmso/en/%s'.format(doc_url) % branch, None) intersphinx_mapping['onap-optf-osdf'] = ('{}/onap-optf-osdf/en/%s'.format(doc_url) % branch, None) intersphinx_mapping['onap-optf-has'] = ('{}/onap-optf-has/en/%s'.format(doc_url) % branch, None) -intersphinx_mapping['onap-sdc-sdc-distribution-client'] = ('{}/onap-sdc-sdc-distribution-client/en/%s'.format(doc_url) % branch, None) +intersphinx_mapping['onap-sdc-sdc-distribution-client'] = ( + '{}/onap-sdc-sdc-distribution-client/en/%s'.format(doc_url) % branch, None) intersphinx_mapping['onap-sdc-sdc-docker-base'] = ('{}/onap-sdc-sdc-docker-base/en/%s'.format(doc_url) % branch, None) intersphinx_mapping['onap-sdc'] = ('{}/onap-sdc/en/%s'.format(doc_url) % branch, None) intersphinx_mapping['onap-clamp'] = ('{}/onap-clamp/en/%s'.format(doc_url) % branch, None) @@ -82,28 +95,26 @@ intersphinx_mapping['onap-aaf-authz'] = ('{}/onap-aaf-authz/en/%s'.format(doc_ur linkcheck_ignore = [ - 'about:config', - # this URL is not directly reachable and must be configured in the system hosts file. - 'https://portal.api.simpledemo.onap.org:30225/ONAPPORTAL/login.htm', - # anchor issues - 'https://docs.onap.org/projects/onap-integration/en/latest/docs_usecases_release.html#.*', - 'https://docs.linuxfoundation.org/docs/communitybridge/easycla/contributors/contribute-to-a-gerrit-project#.*', - 'https://docs.onap.org/projects/onap-integration/en/latest/docs_robot.html#docs-robot', - 'https://docs.onap.org/projects/onap-integration/en/latest/docs_usecases_release.html#docs-usecases-release', - 'https://docs.onap.org/projects/onap-integration/en/latest/docs_usecases.html#docs-usecases', - 'https://docs.onap.org/projects/onap-integration/en/latest/usecases/release_non_functional_requirements.html#release-non-functional-requirements', + 'about:config', + # this URL is not directly reachable and must be configured in the system hosts file. + 'https://portal.api.simpledemo.onap.org:30225/ONAPPORTAL/login.htm', + # anchor issues + 'https://docs.onap.org/projects/onap-integration/en/latest/docs_usecases_release.html#.*', + 'https://docs.linuxfoundation.org/docs/communitybridge/easycla/contributors/contribute-to-a-gerrit-project#.*', + 'https://docs.onap.org/projects/onap-integration/en/latest/docs_robot.html#docs-robot', + 'https://docs.onap.org/projects/onap-integration/en/latest/docs_usecases_release.html#docs-usecases-release', + 'https://docs.onap.org/projects/onap-integration/en/latest/docs_usecases.html#docs-usecases', + 'https://docs.onap.org/projects/onap-integration/en/latest/usecases/release_non_functional_requirements.html#release-non-functional-requirements', ] - html_last_updated_fmt = '%d-%b-%y %H:%M' + def setup(app): app.add_css_file("css/ribbon.css") -from docutils.parsers.rst import directives - needs_extra_options = { "target": directives.unchanged, "keyword": directives.unchanged, @@ -162,4 +173,3 @@ needs_template_collapse = """ | parents: :need_outgoing:`{{id}}` {% endif -%} """ - diff --git a/docs/release-notes.rst b/docs/release-notes.rst index 1f0f6b595..ef431a8a2 100644 --- a/docs/release-notes.rst +++ b/docs/release-notes.rst @@ -12,11 +12,36 @@ Release Notes This document provides the release notes for the documentation project. -Guilin Release -============== +Guilin Releases +=============== -Release data -============ +The following releases are available for Guilin: + - `Guilin Maintenance Release 7.0.1`_ + - `Guilin Major Release 7.0.0`_ + +Guilin Maintenance Release 7.0.1 +================================ + ++--------------------------------------+--------------------------------------+ +| **Project** | Documentation Project | +| | | ++--------------------------------------+--------------------------------------+ +| **Release name** | Guilin Maintenance Release | +| | | ++--------------------------------------+--------------------------------------+ +| **Release version** | 7.0.1 | +| | | ++--------------------------------------+--------------------------------------+ + + +New features +------------ + +- Restructured the user guides section and added new tutorials + + +Guilin Major Release 7.0.0 +========================== +--------------------------------------+--------------------------------------+ | **Project** | Documentation Project | diff --git a/docs/release/index.rst b/docs/release/index.rst index 10382093a..734d55990 100644 --- a/docs/release/index.rst +++ b/docs/release/index.rst @@ -23,14 +23,53 @@ Guilin Releases =============== The following releases are available for Guilin: + - `Guilin Maintenance Release 7.0.1`_ - `Guilin Major Release 7.0.0`_ -Guilin Major Release 7.0.0 -========================== +Guilin Maintenance Release 7.0.1 +================================ + ++--------------------------------------+--------------------------------------+ +| **Project** | Open Network Automation Platform | +| | (ONAP) | ++--------------------------------------+--------------------------------------+ +| **Release name** | Guilin Maintenance Release | +| | | ++--------------------------------------+--------------------------------------+ +| **Release version** | 7.0.1 | +| | | ++--------------------------------------+--------------------------------------+ +| **Release date** | February 28th 2021 | +| | | ++--------------------------------------+--------------------------------------+ -Release data +New Features ============ +Guilin Maintenance Release 7.0.1 delivered a number of fixes and updates +across the following projects: + + - AAI - bug fixes + - OOM - bug fixes + - CCSDK - bug fixes + - DCAEGEN2 - bug fixes + - DMaaP - bug fixes + - DOC - restructure user guides section and added tutorials + - Integration - new docker for robot framework + - Music - certificate update + - MSB - bug fixes + - OOM - docker improvement + - SDNC - bug fixes + - SO - bug fixes + - VID - certificate update + +Details on the specific Jira tickets addressed by each project can be found in +the component specific Release Notes: :ref:`release notes<doc-releaserepos>` + + +Guilin Major Release 7.0.0 +========================== + +--------------------------------------+--------------------------------------+ | **Project** | Open Network Automation Platform | | | (ONAP) | diff --git a/docs/validwords.txt b/docs/spelling_wordlist.txt index c860d4aa0..5140ec258 100644 --- a/docs/validwords.txt +++ b/docs/spelling_wordlist.txt @@ -1,5 +1,6 @@ AAF AAI +ACL adaptor Adaptor adaptors @@ -59,6 +60,7 @@ Fcaps Financials geocoder Gerrit +Git Github graphSON guestOS @@ -141,6 +143,7 @@ Junit JUnit Junits JUnits +Karaf keypair Keypair keypairs @@ -155,6 +158,7 @@ keytool keyValue Kibana Kibibytes +kubectl Kubernetes LF lifecycle @@ -173,6 +177,7 @@ macAddress MacAddress macOS Malware +MariaDB metadata Metadata microservice @@ -217,14 +222,18 @@ onboarding Onboarding online OOF +oom OOM OpenDaylight +OpenFlow openo OpenO Opensource Openstack OpenStack OSS +ovs +ovsdb Pandoc partitionKey Partitionkey @@ -272,6 +281,7 @@ refactored Refactored registrator Registrator +releng repo Repo repos diff --git a/etc/requirements.txt b/etc/requirements.txt index c743bce21..9f5b2aa35 100644 --- a/etc/requirements.txt +++ b/etc/requirements.txt @@ -1,15 +1,8 @@ -tox -Sphinx -doc8 -docutils -setuptools -six -sphinx_rtd_theme>=0.4.3 +sphinx_rtd_theme sphinxcontrib-blockdiag sphinxcontrib-needs<0.6.0 sphinxcontrib-nwdiag sphinxcontrib-seqdiag sphinxcontrib-swaggerdoc sphinxcontrib-plantuml -sphinx_bootstrap_theme lfdocs-conf @@ -36,4 +36,14 @@ deps = -r{toxinidir}/etc/requirements.txt sphinxcontrib-spelling commands = - sphinx-build -b spelling -Dextensions=sphinxcontrib.spelling -Dspelling_word_list_filename=validwords.txt -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/spellcheck + sphinx-build -b spelling -Dextensions=sphinxcontrib.spelling -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/spellcheck + +[testenv:autopep8] +deps = autopep8 +commands = + autopep8 --max-line-length 120 --in-place docs/conf.py + +[testenv:pylint] +deps = pylint +commands = + pylint --max-line-length=120 --disable=missing-docstring --reports=y --score=y --output-format=colorized docs/conf.py |