diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/conf.py | 5 | ||||
| -rw-r--r-- | docs/guides/onap-developer/apiref/index.rst | 9 | ||||
| -rw-r--r-- | docs/guides/onap-developer/architecture/onap-architecture.rst | 3 | ||||
| -rw-r--r-- | docs/guides/onap-developer/architecture/references.rst | 11 | ||||
| -rw-r--r-- | docs/guides/onap-developer/developing/index.rst | 28 | ||||
| -rw-r--r-- | docs/guides/onap-user/index.rst | 7 | ||||
| -rw-r--r-- | docs/guides/onap-user/onapcli.rst | 10 | ||||
| -rw-r--r-- | docs/index.rst | 6 | ||||
| -rw-r--r-- | docs/release/index.rst | 6 | ||||
| -rw-r--r-- | docs/release/releaserepos.rst | 16 |
10 files changed, 5 insertions, 96 deletions
diff --git a/docs/conf.py b/docs/conf.py index ccfccfd86..cfe023bec 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -19,7 +19,6 @@ intersphinx_mapping['onap-ccsdk-cds'] = ('{}/onap-ccsdk-cds/en/%s'.format(doc_ur intersphinx_mapping['onap-ccsdk-distribution'] = ('{}/onap-ccsdk-distribution/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-oran'] = ('{}/onap-ccsdk-oran/en/%s'.format(doc_url) % branch, None) -intersphinx_mapping['onap-cli'] = ('{}/onap-cli/en/%s'.format(doc_url) % branch, None) intersphinx_mapping['onap-cps'] = ('{}/onap-cps/en/%s'.format(doc_url) % branch, None) intersphinx_mapping['onap-cps-cps-temporal'] = ('{}/onap-cps-cps-temporal/en/%s'.format(doc_url) % branch, None) intersphinx_mapping['onap-cps-ncmp-dmi-plugin'] = ('{}/onap-cps-ncmp-dmi-plugin/en/%s'.format(doc_url) % branch, None) @@ -31,7 +30,6 @@ intersphinx_mapping['onap-holmes-engine-management'] = ('{}/onap-holmes-engine-m intersphinx_mapping['onap-holmes-rule-management'] = ('{}/onap-holmes-rule-management/en/%s'.format(doc_url) % branch, None) intersphinx_mapping['onap-integration'] = ('{}/onap-integration/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-modelspec'] = ('{}/onap-modeling-modelspec/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-msb-java-sdk'] = ('{}/onap-msb-java-sdk/en/%s'.format(doc_url) % branch, None) @@ -40,8 +38,6 @@ intersphinx_mapping['onap-multicloud-framework'] = ('{}/onap-multicloud-framewor intersphinx_mapping['onap-multicloud-k8s'] = ('{}/onap-multicloud-k8s/en/%s'.format(doc_url) % branch, None) 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) @@ -50,7 +46,6 @@ 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-vnfsdk-model'] = ('{}/onap-vnfsdk-model/en/%s'.format(doc_url) % branch, None) # Linkcheck linkcheck_ignore = [ diff --git a/docs/guides/onap-developer/apiref/index.rst b/docs/guides/onap-developer/apiref/index.rst index 1e6792348..bc3c1840a 100644 --- a/docs/guides/onap-developer/apiref/index.rst +++ b/docs/guides/onap-developer/apiref/index.rst @@ -53,12 +53,3 @@ Common Services * :ref:`MSB - Micro Services Bus<onap-msb-apigateway:offeredapis>` * :ref:`Multi Cloud<onap-multicloud-framework:offeredapis>` * :ref:`OPTF - Optimization Framework<onap-optf-osdf:offeredapis>` - -SDK ---- - -.. toctree:: - :maxdepth: 1 - :titlesonly: - -* :ref:`VNF Software Development Kit<onap-vnfsdk-model:offeredapis>` diff --git a/docs/guides/onap-developer/architecture/onap-architecture.rst b/docs/guides/onap-developer/architecture/onap-architecture.rst index d66464e93..5c45b4afa 100644 --- a/docs/guides/onap-developer/architecture/onap-architecture.rst +++ b/docs/guides/onap-developer/architecture/onap-architecture.rst @@ -597,8 +597,7 @@ requirements of various use cases, guide the development and bring consistency among ONAP components and explore a common model to improve the interoperability of ONAP. -ONAP supports various models detailed in -:ref:`Modeling Documentation<onap-modeling-modelspec:master_index>`. +ONAP supports various models detailed in the Modeling documentation. The modeling project includes the ETSI catalog component, which provides the parser functionalities, as well as additional package management diff --git a/docs/guides/onap-developer/architecture/references.rst b/docs/guides/onap-developer/architecture/references.rst index 08e119de1..a169c5797 100644 --- a/docs/guides/onap-developer/architecture/references.rst +++ b/docs/guides/onap-developer/architecture/references.rst @@ -14,15 +14,6 @@ References ========== -Models ------- - -.. toctree:: - :maxdepth: 1 - :titlesonly: - -:ref:`Model Specifications<onap-modeling-modelspec:master_index>` - User Interfaces --------------- @@ -31,7 +22,6 @@ User Interfaces :titlesonly: | :ref:`Policy/CLAMP - Closed Loop Automation Platform<onap-policy-parent:clamp-label>` -| :ref:`CLI - Command Line Interface<onap-cli:architecture>` | :ref:`SDC - Service Design and Creation<onap-sdc:architecture>` | :ref:`UUI- Usecase UI<onap-usecase-ui:architecture>` @@ -63,4 +53,3 @@ Common Services | :ref:`Multi Cloud<onap-multicloud-framework:multicloud-administrator-guide>` | :ref:`OOM - ONAP Operations Manager<onap-oom:oom_project_description>` | :ref:`OPTF - Optimization Framework<onap-optf-osdf:architecture>` -| :ref:`VNF SDK<onap-vnfsdk-model:offeredapis>` diff --git a/docs/guides/onap-developer/developing/index.rst b/docs/guides/onap-developer/developing/index.rst index ab21b936a..ec8050f24 100644 --- a/docs/guides/onap-developer/developing/index.rst +++ b/docs/guides/onap-developer/developing/index.rst @@ -46,19 +46,6 @@ CCSDK - Common Controller Software Development Kit * - :ref:`ccsdk/oran<onap-ccsdk-oran:master_index>` - O-RAN Support in ONAP - -CLI - Command Line Interface ----------------------------- - -.. list-table:: - :widths: auto - :header-rows: 1 - - * - Component - - Documentation - * - :ref:`cli<onap-cli:master_index>` - - CLI - CPS - Configuration Persistence Service --------------------------------------- @@ -138,8 +125,6 @@ MOD - Modeling * - Component - Documentation - * - :ref:`modeling/modelspec<onap-modeling-modelspec:master_index>` - - Model Specification * - :ref:`modeling/etsicatalog<onap-modeling-etsicatalog:master_index>` - ETSI Runtime Catalog @@ -186,8 +171,6 @@ OOM - ONAP Operations Manager - Documentation * - :ref:`oom<onap-oom:master_index>` - ONAP Operations Manager - * - :ref:`oom/platform/cert-service<onap-oom-platform-cert-service:master_index>` - - ONAP CMPv2 Certification Support * - :ref:`oom/offline-installer<onap-oom-offline-installer:master_index>` - OOM Offline Installer @@ -277,14 +260,3 @@ VFC - Virtual Function Controller * - :ref:`vfc/nfvo/lcm<onap-vfc-nfvo-lcm:master_index>` - Virtual Function Controller Architecture, APIs and Guides -VNFSDK - VNF Software Development Kit -------------------------------------- - -.. list-table:: - :widths: auto - :header-rows: 1 - - * - Component - - Documentation - * - :ref:`vnfsdk/model<onap-vnfsdk-model:master_index>` - - VNF SDK, User Guides diff --git a/docs/guides/onap-user/index.rst b/docs/guides/onap-user/index.rst index b3e9fc655..adc3a1177 100644 --- a/docs/guides/onap-user/index.rst +++ b/docs/guides/onap-user/index.rst @@ -24,12 +24,7 @@ E2E User Guides Component User Guides --------------------- -.. toctree:: - :maxdepth: 1 - - onapcli.rst - -For other ONAP components please review the individual +For ONAP components please review the individual document sets in :ref:`doc_onap-developer_guide_projects` Verified Use Cases diff --git a/docs/guides/onap-user/onapcli.rst b/docs/guides/onap-user/onapcli.rst deleted file mode 100644 index 57b330c5f..000000000 --- a/docs/guides/onap-user/onapcli.rst +++ /dev/null @@ -1,10 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. - - -ONAP CLI -======== - -.. toctree:: - :maxdepth: 2 - -:ref:`ONAP CLI userguide<onap-cli:cli_user_guide>` diff --git a/docs/index.rst b/docs/index.rst index 0caf46940..2f4df5f99 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -24,7 +24,7 @@ Please find some guidance here on the content of ONAP documentation: +---------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+ | Main documentation areas | Description | +=================================================================================+===============================================================================================+ - | :ref:`Release Notes <onap-release-notes>` | The Release Notes are providing general information about the ONAP release and recent changes,| + | :ref:`ONAP Release Notes <onap-release-notes>` | The Release Notes are providing general information about the ONAP release and recent changes,| | | feature enhancements, or bug fixes. | +---------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+ | :ref:`Project Specific Release Notes <doc-releaserepos>` | The Project Specific Release Notes are providing information about recent changes, feature | @@ -57,10 +57,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:`ONAP Security <onap-security>` | The current state of ONAP Security is described here. We can learn about discovered and fixed | - | | vulnerabilities. | - +---------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+ - .. toctree:: :maxdepth: 1 diff --git a/docs/release/index.rst b/docs/release/index.rst index 3228c2e42..cb2e1f2be 100644 --- a/docs/release/index.rst +++ b/docs/release/index.rst @@ -253,10 +253,8 @@ The `developer wiki <http://wiki.onap.org>`_ remains a good source of information on meeting plans and notes from committees, project teams and community events. -Security Notes -============== -Details about discovered and mitigated vulnerabilities are in -:ref:`ONAP Security <onap-osa:onap-security>` +CII Best Practice +================= ONAP has adopted the `CII Best Practice Badge Program <https://bestpractices.coreinfrastructure.org/en>`_. diff --git a/docs/release/releaserepos.rst b/docs/release/releaserepos.rst index 6f238bb34..d93a024e2 100644 --- a/docs/release/releaserepos.rst +++ b/docs/release/releaserepos.rst @@ -25,10 +25,6 @@ CCSDK - Common Controller Software Development Kit - :ref:`ccsdk/distribution <onap-ccsdk-distribution:release_notes>` - :ref:`ccsdk/oran <onap-ccsdk-oran:release_notes>` -CLI - Command Line Interface ----------------------------- -- :ref:`cli <onap-cli:release_notes>` - CPS - Configuration Persistence Service --------------------------------------- - :ref:`cps <onap-cps:release_notes>` @@ -60,7 +56,6 @@ INT - Integration MODELING - Modeling ------------------- - :ref:`modeling/etsicatalog <onap-modeling-etsicatalog:release_notes>` -- :ref:`modeling/modelspec <onap-modeling-modelspec:release_notes>` MSB - Microservices Bus ----------------------- @@ -78,13 +73,6 @@ OOF - Optimization Framework OOM - ONAP Operations Manager ----------------------------- - :ref:`oom <onap-oom:release_notes>` -- :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 ------------------------- @@ -109,7 +97,3 @@ UUI - Use Case User Interface VFC - Virtual Function Controller --------------------------------- - :ref:`vfc/nfvo/lcm <onap-vfc-nfvo-lcm:release_notes>` - -VNFSDK - VNF Software Development Kit -------------------------------------- -- :ref:`vnfsdk/model <onap-vnfsdk-model:release_notes>` |