diff options
| -rw-r--r-- | docs/conf.py | 15 | ||||
| -rw-r--r-- | docs/guides/onap-developer/developing/index.rst | 12 | ||||
| -rw-r--r-- | docs/guides/onap-provider/index.rst | 21 | ||||
| -rw-r--r-- | docs/guides/onap-provider/vnfvalidator.rst | 11 | ||||
| -rw-r--r-- | docs/guides/onap-user/design/pre-onboarding/index.rst | 23 | ||||
| -rw-r--r-- | docs/index.rst | 5 | ||||
| -rw-r--r-- | docs/release/releaserepos.rst | 12 |
7 files changed, 9 insertions, 90 deletions
diff --git a/docs/conf.py b/docs/conf.py index 85784b882..ccfccfd86 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -41,6 +41,7 @@ intersphinx_mapping['onap-multicloud-k8s'] = ('{}/onap-multicloud-k8s/en/%s'.for intersphinx_mapping['onap-oom'] = ('{}/onap-oom/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-platform-cert-service'] = ('{}/onap-oom-platform-cert-service/en/%s'.format(doc_url) % branch, None) +intersphinx_mapping['onap-osa'] = ('{}/onap-osa/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-optf-osdf'] = ('{}/onap-optf-osdf/en/%s'.format(doc_url) % branch, None) intersphinx_mapping['onap-policy-parent'] = ('{}/onap-policy-parent/en/%s'.format(doc_url) % branch, None) @@ -49,21 +50,7 @@ intersphinx_mapping['onap-sdnc-oam'] = ('{}/onap-sdnc-oam/en/%s'.format(doc_url) intersphinx_mapping['onap-so'] = ('{}/onap-so/en/%s'.format(doc_url) % branch, None) intersphinx_mapping['onap-usecase-ui'] = ('{}/onap-usecase-ui/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-vnfrqts-guidelines'] = ('{}/onap-vnfrqts-guidelines/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-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-vnfsdk-model'] = ('{}/onap-vnfsdk-model/en/%s'.format(doc_url) % branch, None) -intersphinx_mapping['onap-vvp-documentation'] = ('{}/onap-vvp-documentation/en/%s'.format(doc_url) % branch, None) - -# -# Pinned to 'latest' (master) version of documentation for those projects who -# are part of the new ONAP release but never have created a branch. -# - -branch = 'latest' -# exception for the SecCom repo -intersphinx_mapping['onap-osa'] = ('{}/onap-osa/en/%s'.format(doc_url) % branch, None) # Linkcheck linkcheck_ignore = [ diff --git a/docs/guides/onap-developer/developing/index.rst b/docs/guides/onap-developer/developing/index.rst index 5cec47999..ab21b936a 100644 --- a/docs/guides/onap-developer/developing/index.rst +++ b/docs/guides/onap-developer/developing/index.rst @@ -288,15 +288,3 @@ VNFSDK - VNF Software Development Kit - Documentation * - :ref:`vnfsdk/model<onap-vnfsdk-model:master_index>` - VNF SDK, User Guides - -VVP - VNF Validation Platform ------------------------------ - -.. list-table:: - :widths: auto - :header-rows: 1 - - * - Component - - Documentation - * - :ref:`vvp/documentation<onap-vvp-documentation:master_index>` - - VNF Validation Platform diff --git a/docs/guides/onap-provider/index.rst b/docs/guides/onap-provider/index.rst deleted file mode 100644 index b24a1eda7..000000000 --- a/docs/guides/onap-provider/index.rst +++ /dev/null @@ -1,21 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 -.. International License. http://creativecommons.org/licenses/by/4.0 -.. Copyright 2017 AT&T Intellectual Property. All rights reserved. - -.. _vnf_pnf_reqs: - -VNF and PNF Requirements and Guidelines -======================================= - -The following includes guides and requirements to -describe tasks that an VNF or PNF provider of ONAP may need to properly -set up an VNF or PNF for ONAP usage. - -.. toctree:: - :maxdepth: 2 - -* :ref:`VNF Guidelines<onap-vnfrqts-guidelines:master_index>` -* :ref:`VNF or PNF Requirements Documentation<onap-vnfrqts-requirements:master_index>` -* :ref:`VNF Test Case Descriptions<onap-vnfrqts-testcases:master_index>` -* :ref:`VNF Provider Use Cases<onap-vnfrqts-usecases:master_index>` -* :ref:`VNFRQTS Project Release Notes<onap-vnfrqts-requirements:release_notes>` diff --git a/docs/guides/onap-provider/vnfvalidator.rst b/docs/guides/onap-provider/vnfvalidator.rst deleted file mode 100644 index 854f06c44..000000000 --- a/docs/guides/onap-provider/vnfvalidator.rst +++ /dev/null @@ -1,11 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 -.. International License. - -VNF Validation Documentation -============================ - -.. toctree:: - :maxdepth: 2 - -* :ref:`vvp documentation<onap-vvp-documentation:master_index>` -* :ref:`vvp documentation release-notes<onap-vvp-documentation:release_notes>` diff --git a/docs/guides/onap-user/design/pre-onboarding/index.rst b/docs/guides/onap-user/design/pre-onboarding/index.rst index b712958aa..8dc2af8a0 100644 --- a/docs/guides/onap-user/design/pre-onboarding/index.rst +++ b/docs/guides/onap-user/design/pre-onboarding/index.rst @@ -30,10 +30,10 @@ MANIFEST.json file a script can be used offered by the SDC project: These steps are performed outside SDC. **Prerequisites:** Obtain Heat/ENV files and other files required for -onboarding. The requirements are found in the following document. +onboarding. The requirements are found in the following document: ONAP VNF +Requirements -> Heat Requirements. - -:ref:`Heat requirements<onap-vnfrqts-requirements:heat_requirements>` +.. warning:: ONAP VNF Requirements (vnfrqts) are no longer maintained! #. Put the Heat, ENV, nested Heat, and other files used by get-file in templates in a directory on a host, which supports python. @@ -71,22 +71,15 @@ Example packages can be found in the SDC poject: `example-packages`_ Validate xNF Package (VNF/PNF) ------------------------------ -VNF and PNF packages have to follow the requirements described in: +VNF and PNF packages have to follow the requirements described in "VNF and PNF +Modeling Requirements -> TOSCA Requirements" and "ONAP Management +Requirements". -:ref:`VNF and PNF Modeling Requirements -<onap-vnfrqts-requirements:tosca_requirements>` +.. warning:: ONAP VNF Requirements (vnfrqts) are no longer maintained! -:ref:`ONAP Management Requirements -<onap-vnfrqts-requirements:onap_management_requirements>` For Validation of VNF and PNF packages the tools delivered by VNFSDK can be -used: - -.. toctree:: - :maxdepth: 1 - :titlesonly: - - ../../../onap-provider/vnfvalidator.rst +used. Prior to resource onboarding, the Certification Group does the following: diff --git a/docs/index.rst b/docs/index.rst index f7cfd7b96..aa356f79b 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -54,10 +54,6 @@ Please find some guidance here on the content of ONAP documentation: | | in the ONAP Documentation Guide. Currently some content resides also in the Developer Guide. | | | This is subject to be reviewed, updated and migrated to the ONAP Documenation Guide. | +---------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+ - | :ref:`VNF/PNF Requirements and Guidelines <vnf_pnf_reqs>` | Harmonized VNF and PNF requirements and reduced customization of onboarding VNFs | - | | and PNFs can accelerate the optimal usage of this ONAP environment. The guidelines | - | | on VNF/PNF requirements facilitates synchronized and aligned activities for all participants. | - +---------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+ | :ref:`ONAP Security <onap-security>` | The current state of ONAP Security is described here. We can learn about discovered and fixed | | | vulnerabilities. | +---------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+ @@ -76,4 +72,3 @@ Please find some guidance here on the content of ONAP documentation: guides/onap-user/index guides/onap-developer/index guides/onap-documentation/index - guides/onap-provider/index diff --git a/docs/release/releaserepos.rst b/docs/release/releaserepos.rst index ba7dd8a61..6467cff32 100644 --- a/docs/release/releaserepos.rst +++ b/docs/release/releaserepos.rst @@ -80,13 +80,11 @@ OOM - ONAP Operations Manager - :ref:`oom/platform/cert-service <onap-oom-platform-cert-service:release_notes>` - .. OSA - ONAP Security Advisories .. ------------------------------ .. - :ref:`osa <onap-osa:release_notes>` - POLICY - Policy Framework ------------------------- - :ref:`policy/parent <onap-policy-parent:release_notes>` @@ -111,16 +109,6 @@ VFC - Virtual Function Controller --------------------------------- - :ref:`vfc/nfvo/lcm <onap-vfc-nfvo-lcm:release_notes>` -VNFRQTS - VNF Requirements --------------------------- -- :ref:`vnfrqts/requirements <onap-vnfrqts-requirements:release_notes>` -- :ref:`vnfrqts/testcases <onap-vnfrqts-testcases:release_notes>` -- :ref:`vnfrqts/usecases <onap-vnfrqts-usecases:release_notes>` - VNFSDK - VNF Software Development Kit ------------------------------------- - :ref:`vnfsdk/model <onap-vnfsdk-model:release_notes>` - -VVP - VNF Validation Project ----------------------------- -- :ref:`vvp/documentation <onap-vvp-documentation:release_notes>` |