diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/conf.py | 3 | ||||
| -rw-r--r-- | docs/guides/active-projects/index.rst | 1 | ||||
| -rw-r--r-- | docs/guides/onap-developer/architecture/references.rst | 2 | ||||
| -rw-r--r-- | docs/guides/onap-developer/developing/index.rst | 6 | ||||
| -rw-r--r-- | docs/guides/onap-developer/how-to-use-docs/include-documentation.rst | 6 | ||||
| -rw-r--r-- | docs/guides/onap-user/design/pre-onboarding/index.rst | 6 | ||||
| -rw-r--r-- | docs/release-notes.rst | 27 | ||||
| -rw-r--r-- | docs/release/index.rst | 53 |
8 files changed, 91 insertions, 13 deletions
diff --git a/docs/conf.py b/docs/conf.py index 6a1d71ac7..e026b527f 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -43,10 +43,9 @@ intersphinx_mapping['onap-policy-parent'] = ('{}/onap-policy-parent/en/%s'.forma 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-policy-engine'] = ('{}/onap-policy-engine/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-aaf-certservice'] = ('{}/onap-aaf-certservice/en/%s'.format(doc_url) % branch, None) +intersphinx_mapping['onap-oom-certservice'] = ('{}/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-sdnc-oam'] = ('{}/onap-sdnc-oam/en/%s'.format(doc_url) % branch, None) diff --git a/docs/guides/active-projects/index.rst b/docs/guides/active-projects/index.rst index 7e43bdd13..6b72b3aeb 100644 --- a/docs/guides/active-projects/index.rst +++ b/docs/guides/active-projects/index.rst @@ -39,7 +39,6 @@ All Active Projects | :ref:`onap-vfc-nfvo-lcm <onap-vfc-nfvo-lcm:master_index>` | :ref:`onap-vfc-nfvo-driver-vnfm-svnfm <onap-vfc-nfvo-driver-vnfm-svnfm:master_index>` | :ref:`onap-holmes-rule-management <onap-holmes-rule-management:master_index>` -| :ref:`onap-policy-engine <onap-policy-engine:master_index>` | :ref:`onap-portal <onap-portal:master_index>` | :ref:`onap-cli <onap-cli:master_index>` | :ref:`onap-aaf-certservice <onap-aaf-certservice:master_index>` diff --git a/docs/guides/onap-developer/architecture/references.rst b/docs/guides/onap-developer/architecture/references.rst index 5c3dcac04..93b4dc68a 100644 --- a/docs/guides/onap-developer/architecture/references.rst +++ b/docs/guides/onap-developer/architecture/references.rst @@ -47,7 +47,7 @@ Platform Components | :ref:`APPC - Application Controller<onap-appc:master_index>` | :ref:`DCAE - Data Collection Analytics and Events<onap-dcaegen2:architecture>` | :ref:`Holmes<onap-holmes-rule-management:architecture>` -| :ref:`Policy<onap-policy-engine:architecture>` +| :ref:`Policy<onap-policy-parent:architecture>` | :ref:`SDNC - SDN Controller OAM<onap-sdnc-oam:architecture>` | :ref:`SO - Service Orchestrator<onap-so:architecture>` | :ref:`VFC - Virtual Function Controller<onap-vfc-nfvo-lcm:architecture>` diff --git a/docs/guides/onap-developer/developing/index.rst b/docs/guides/onap-developer/developing/index.rst index e0bc103a3..e4bb6b149 100644 --- a/docs/guides/onap-developer/developing/index.rst +++ b/docs/guides/onap-developer/developing/index.rst @@ -44,7 +44,6 @@ Application Authorization Framework | :ref:`aaf authz<onap-aaf-authz:master_index>` | :ref:`Secret Management Service<onap-aaf-sms:master_index>` -| :ref:`Certification Service<onap-aaf-certservice:master_index>` Command Line Interface ---------------------- @@ -203,7 +202,8 @@ ONAP Operations Manager :maxdepth: 2 :titlesonly: -:ref:`oom<onap-oom:master_index>` +| :ref:`oom<onap-oom:master_index>` +| :ref:`CMPv2 CertService<onap-oom-certservice:master_index>` Optimization Framework ---------------------- @@ -225,8 +225,6 @@ Policy Framework :ref:`policy parent<onap-policy-parent:master_index>` -:ref:`policy engine<onap-policy-engine:master_index>` - Portal Platform --------------- diff --git a/docs/guides/onap-developer/how-to-use-docs/include-documentation.rst b/docs/guides/onap-developer/how-to-use-docs/include-documentation.rst index c59e956a1..91f530983 100644 --- a/docs/guides/onap-developer/how-to-use-docs/include-documentation.rst +++ b/docs/guides/onap-developer/how-to-use-docs/include-documentation.rst @@ -475,6 +475,12 @@ Change directory to doc & install requirements. cd doc pip install -r etc/requirements.txt +.. warning:: + + Just follow the next step (copying conf.py from Doc project to your project) + if that is your intention, otherwise skip it. Currently all projects should already have a conf.py file. + Through the next step, this file and potential extensions in your project get overriden. + Copy the conf.py file to your project folder where RST files have been kept: .. code-block:: bash diff --git a/docs/guides/onap-user/design/pre-onboarding/index.rst b/docs/guides/onap-user/design/pre-onboarding/index.rst index 07510ef04..42b1ca0f7 100644 --- a/docs/guides/onap-user/design/pre-onboarding/index.rst +++ b/docs/guides/onap-user/design/pre-onboarding/index.rst @@ -32,7 +32,7 @@ These steps are performed outside SDC. onboarding. The requirements are found in the following document. -:ref:`Heat requirements<onap-vnfrqts-requirements:master_index>` +:ref:`Heat requirements<onap-vnfrqts-requirements:heat_requirements>` #. Put the Heat, ENV, nested Heat, and other files used by get-file in templates in a directory on a host, which supports python. @@ -72,9 +72,9 @@ Validate xNF Package (VNF/PNF) VNF and PNF packages have to follow the requirements described in: -:ref:`VNF and PNF Modeling Requirements<vnfrqts-requirements:master_index>` +:ref:`VNF and PNF Modeling Requirements<vnfrqts-requirements:tosca_requirements>` -:ref:`ONAP Management Requirements<vnfrqts-requirements:master_index>` +:ref:`ONAP Management Requirements<vnfrqts-requirements:onap_management_requirements>` For Validation of VNF and PNF packages the tools delivered by VNFSDK can be used: diff --git a/docs/release-notes.rst b/docs/release-notes.rst index 720952391..84a7da754 100644 --- a/docs/release-notes.rst +++ b/docs/release-notes.rst @@ -10,6 +10,33 @@ Release Notes This document provides the release notes for the documentation project. +Frankfurt Maintenance Release 6.0.1 +=================================== + +Release data +============ + ++--------------------------------------+--------------------------------------+ +| **Project** | Open Network Automation Platform | +| | (ONAP) | ++--------------------------------------+--------------------------------------+ +| **Release name** | Frankfurt | +| | | ++--------------------------------------+--------------------------------------+ +| **Release version** | 6.0.1 | +| | | ++--------------------------------------+--------------------------------------+ +| **Release date** | August 17th 2020 | +| | | ++--------------------------------------+--------------------------------------+ + +New features +------------ + +- no updates + +Frankfurt Release 6.0.0 +======================= Release Data ------------ diff --git a/docs/release/index.rst b/docs/release/index.rst index 96ba91215..8c2035b80 100644 --- a/docs/release/index.rst +++ b/docs/release/index.rst @@ -16,9 +16,19 @@ have an entry for each Major, Minor, and Maintenance release, if applicable. Each component within the ONAP solution maintains their own component level release notes and links to those release notes are provided below. -Details on the specific items delivered in each releaese by each component is +Details on the specific items delivered in each release by each component is maintained in the component specific release notes. +Frankfurt Releases +================== + +The following releases are available for Frankfurt: + - `Frankfurt Major Release 6.0.0`_ + - `Frankfurt Maintenance Release 6.0.1`_ + +Frankfurt Maintenance Release 6.0.1 +=================================== + Release data ============ @@ -29,7 +39,45 @@ Release data | **Release name** | Frankfurt | | | | +--------------------------------------+--------------------------------------+ -| **Release version** | Frankfurt 6.0.0 | +| **Release version** | 6.0.1 | +| | | ++--------------------------------------+--------------------------------------+ +| **Release date** | August 17th 2020 | +| | | ++--------------------------------------+--------------------------------------+ + +Frankfurt Maintenance Release 6.0.1 delivered a number of fixes and updates +across the following projects: + +- AAF +- OOM +- CCSDK +- CLAMP +- DCAEGEN2 +- Integration +- POLICY +- SDC +- SO +- TEST + +Details on the specific Jira tickets addressed by each project can be found in +the component specific Release Notes. Link can be found below in section +`Project Specific Release Notes`_. + +Frankfurt Major Release 6.0.0 +============================= + +Release data +============ + ++--------------------------------------+--------------------------------------+ +| **Project** | Open Network Automation Platform | +| | (ONAP) | ++--------------------------------------+--------------------------------------+ +| **Release name** | Frankfurt | +| | | ++--------------------------------------+--------------------------------------+ +| **Release version** | 6.0.0 | | | | +--------------------------------------+--------------------------------------+ | **Release date** | June 11th 2020 | @@ -41,6 +89,7 @@ Project Specific Release Notes ONAP releases are specified by a list of project artifact versions in the project repositories and docker container image versions listed in the OOM Helm charts. + Each project provides detailed :ref:`release notes<doc-releaserepos>` and prepends to these if/when any updated versions the project team believes are compatible with a major release are made available. |