improve doc navigation (project specific release notes)

Issue-ID: DOC-798

Signed-off-by: thmsdt <thomas.kulik@telekom.de>
Change-Id: Iad0b8cd373aaa70dc4ad56c6416fbeae4fb8ccc0

diff --git a/docs/index.rst b/docs/index.rst
index 2b6a0e3..e0bd37d 100644 (file)
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -23,7 +23,7 @@ Please find some guidance here on the content of ONAP documentation:
  +---------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+
  | Main documentation areas                                                        | Description                                                                                   |
  +=================================================================================+===============================================================================================+
- | :ref:`ONAP Release Notes <onap-release-notes>`                                  | The Release Notes are providing general information about the ONAP release and recent changes,|
+ | :ref:`ONAP 'Jakarta' 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    |
@@ -53,7 +53,7 @@ Please find some guidance here on the content of ONAP documentation:
  |                                                                                 | ONAP Documentation Guide. Currently some content resides also in the Developer Guide. This is |
  |                                                                                 | subject to be reviewed, updated and migrated to the ONAP Documentation Guide.                 |
  +---------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+
- | :ref:`ONAP Security <onap-security>`                                            | The current state of ONAP Security is described here. We can learn about discovered and fixed |
+ | :ref:`ONAP Security <onap-security>`                                            | The current state of ONAP Security is described here. You can learn about discovered and fixed|
  |                                                                                 | vulnerabilities.                                                                              |
  +---------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+
 

diff --git a/docs/release/index.rst b/docs/release/index.rst
index 7fd8533..8cae3e0 100644 (file)
--- a/docs/release/index.rst
+++ b/docs/release/index.rst
@@ -4,10 +4,10 @@
 
 .. _onap-release-notes:
 
-Jakarta Release Notes
-^^^^^^^^^^^^^^^^^^^^^
+ONAP 'Jakarta' Release Notes
+============================
 
-This page provides the release notes for the ONAP Jakarta release. This
+This page provides the release notes for the ONAP 'Jakarta' release. This
 includes details of software versions, known limitations, and outstanding
 trouble reports.
 
@@ -20,7 +20,7 @@ Details on the specific items delivered in each release by each component is
 maintained in the component specific release notes.
 
 Jakarta Major Release 10.0.0
-============================
+----------------------------
 
 +--------------------------------------+--------------------------------------+
 | **Project**                          | Open Network Automation Platform     |
@@ -37,7 +37,7 @@ Jakarta Major Release 10.0.0
 +--------------------------------------+--------------------------------------+
 
 Features
---------
+^^^^^^^^
 ONAP Jakarta focusses on:
 
 - Security enhancements in the A&AI, CCSDK, MSB, and MultiCloud projects,
@@ -63,10 +63,10 @@ ONAP Jakarta focusses on:
   and KubeRef RI2
 
 Functional Requirements
------------------------
+^^^^^^^^^^^^^^^^^^^^^^^
 
 Increased Cloud Native Functionality
-....................................
+""""""""""""""""""""""""""""""""""""
 
 - Improved synchronization of k8s resources after the creation of the CNF.
   When some change occurs for the CNF in the k8s cluster, k8splugin sends
@@ -88,7 +88,7 @@ Increased Cloud Native Functionality
 - New model for CNF modeling: Application Service Descriptor (ASD) model
 
 E2E Network Slicing
-...................
+"""""""""""""""""""
 
 - CPS Integration with SDN-R for RAN Slice allocate and reconfigure scenarios
 - E2E network Slicing with CPS is completed for allocation and re-use scenarios
@@ -103,7 +103,7 @@ E2E Network Slicing
 - Closed-loop enhancement in CCVPN to support Transport Slicing’s closed-loop
 
 Control Loop evolutions
-.......................
+"""""""""""""""""""""""
 
 - Control Loop in TOSCA LCM Improvement: abstract Automation Composition
   Management (ACM) logic with a generic Automation Composition definition,
@@ -147,14 +147,14 @@ Control Loop evolutions
   - Scripts are added to make release of the Policy Framework easier
 
 Fault management
-................
+""""""""""""""""
 
 - DCAE Helm Transformation finalized
 - Topic alignment for DCAE microservices:  use standard topics for PM-Mapper,
   Slice-Analysis and KPI-MS
 
 Extended O-RAN Integration
-..........................
+""""""""""""""""""""""""""
 
 - The O-RAN A1 interface (from the CCSDK project) provides a flexible way for
   RAN operators to manage wide area RAN network optimization
@@ -168,39 +168,39 @@ Extended O-RAN Integration
 
 
 Controllers
-...........
+"""""""""""
 
 - SDN-C is upgraded to OpenDaylight Phosphorus release
 - Enhancements to CCVPN, Network Slicing, and ONAP A1 Interface
 
 Service Design
-..............
+""""""""""""""
 
 - Improved support for TOSCA features
 - Automation Composition Management model
 - Support for large CSAR via S3 storage
 
 Inventory
-.........
+"""""""""
 
 - Schema updated for CCVPN use case mainly enhancing and bug fixes of the Cloud
   Leased Line (CLL) service
 
 ONAP Operations Manager
-.......................
+"""""""""""""""""""""""
 
 - Introduction of Strimzi Kafka Operator
 - Migration of all Kafka native clients to use Strimzi Apache Kafka.
 - Disable VID, Portal
 
 Non-Functional Requirements
----------------------------
+^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 The following 'non-functional' requirements are followed in the
 Jakarta Release:
 
 Best Practice
-.............
+"""""""""""""
 
 - ONAP shall use STDOUT for logs collection
 - IPv4/IPv6 dual stack support in ONAP
@@ -211,7 +211,7 @@ Best Practice
 - No root (superuser) access to database from application container
 
 Code Quality
-............
+""""""""""""
 
 - Each ONAP project shall improve its CII Badging score by improving input
   validation and documenting it in their CII Badging site
@@ -219,7 +219,7 @@ Code Quality
   least 55% code coverage
 
 Security
-........
+""""""""
 
 - Python language 3.8
 - Java language v11
@@ -231,7 +231,7 @@ Security
   Tools for automated SBOM creation are now rolled into the CI chain of ONAP
 
 Documentation
-.............
+"""""""""""""
 
 - Documentation cleaned up. Chapters which include unmaintained projects were
   removed to avoid misunderstandings at the readership
@@ -244,7 +244,7 @@ Documentation
 - The guide to set up a development system for documentation is updated
 
 Tests & Integration
-...................
+"""""""""""""""""""
 
 - Create Java and Python base images
 - Adapt robot tests to DCAE project changes: Cloudify to Helm migration
@@ -256,27 +256,18 @@ Tests & Integration
    Some non-functional requirements are not fully finalized. Please, check details
    on the :doc:`Integration<usecases/release_non_functional_requirements>`
 
-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.
+Documentation Sources
+^^^^^^^^^^^^^^^^^^^^^
 
-Documentation
-=============
-ONAP Jakarta Release provides a set selection of documents,
-see :ref:`ONAP Documentation<master_index>`.
+The formal ONAP 'Jakarta' Release Documentation is available
+in :ref:`ReadTheDocs<master_index>`.
 
-The `developer wiki <http://wiki.onap.org>`_ remains a good source of
+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.
 
 CII Best Practice
-=================
+^^^^^^^^^^^^^^^^^
 
 ONAP has adopted the `CII Best Practice Badge Program <https://bestpractices.coreinfrastructure.org/en>`_.
 
@@ -295,7 +286,7 @@ each project.
 .. index:: maturity
 
 ONAP Maturity Testing Notes
-===========================
+^^^^^^^^^^^^^^^^^^^^^^^^^^^
 For the Jakarta release, ONAP continues to improve in multiple areas of
 Scalability, Security, Stability and Performance (S3P) metrics.
 
@@ -307,6 +298,6 @@ In Jakarta the Integration team focussed in
 More details in :ref:`ONAP Integration Project<onap-integration:master_index>`
 
 Known Issues and Limitations
-============================
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 Known Issues and limitations are documented in each
 :ref:`project Release Notes <doc-releaserepos>`.

diff --git a/docs/release/releaserepos.rst b/docs/release/releaserepos.rst
index d91b2f1..1f102ff 100644 (file)
--- a/docs/release/releaserepos.rst
+++ b/docs/release/releaserepos.rst
@@ -8,12 +8,13 @@
 :orphan:
 
 Project Specific Release Notes
-++++++++++++++++++++++++++++++
+==============================
 
-.. toctree::
-   :maxdepth: 1
-
--------------------------------------------------------------------------------
+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 release notes and prepends to these
+if/when any updated versions the project team believes are compatible with a
+major release are made available.
 
 AAI - Active and Available Inventory
 ------------------------------------