Update release note table

[doc.git] / docs / release / index.rst

diff --git a/docs/release/index.rst b/docs/release/index.rst
index bfd896f..453d7c1 100644 (file)
--- a/docs/release/index.rst
+++ b/docs/release/index.rst
@@ -1,32 +1,99 @@
-.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. This work is licensed under a Creative Commons Attribution 4.0
+   International License. http://creativecommons.org/licenses/by/4.0
 
 
-Release
-=======
+.. _release-notes:
 
-Overview of use cases, installation, release notes, etc.
+El Alto Release Notes
+^^^^^^^^^^^^^^^^^^^^^
 
+This page provides the release notes for the ONAP El Alto release. This
+includes details of software versions used, known limitations, and outstanding
+trouble reports.
 
-Architecture
-------------
+Release notes are cumulative for the release, meaning this release note for the
+El Alto release will 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
+maintained in the component specific release notes.
 
-Use Cases
----------
+El Alto Major Release 5.0.1
+===========================
 
+* Release Name: El Alto
+* Release Version: 5.0.1
+* Release Date: October 24 2019
 
-Tutorials
----------
+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
+=============
+ONAP El Alto Release provides a set selection of documents,
+see :ref:`ONAP Home<master_index>`.
 
+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.
 
-Release Notes
--------------
+Security Notes
+==============
+Details about discovered and mitigated vulnerabilities are in
+:ref:`ONAP Security <onap-security>`
 
+.. toctree::
+   :hidden:
 
-Component Specific Notes
-++++++++++++++++++++++++
+   ../submodules/osa.git/docs/index.rst
+
+ONAP has adopted the `CII Best Practice Badge Program <https://bestpractices.coreinfrastructure.org/en>`_.
+
+- `Badging Requirements <https://github.com/coreinfrastructure/best-practices-badge#core-infrastructure-initiative-best-practices-badge>`_
+- `Badging Status for all ONAP projects <https://bestpractices.coreinfrastructure.org/en/projects?q=onap>`_
+
+Project specific details are in the :ref:`release notes<doc-releaserepos>` for
+each project.
+
+.. index:: maturity
+
+ONAP Maturity Testing Notes
+===========================
+For El Alto release, ONAP continues to improve in multiple areas of
+Scalability, Security, Stability and Performance (S3P) metrics.
+
+The Integration team ran the 72 hours stability testing (100% passing rate)
+and full resilience testing (99.4% passing rate) at ONAP OpenLabs. More details
+in :ref:`ONAP Maturity Testing Notes <integration-s3p>`
+
+Known Issues and Limitations
+============================
+Known Issues and limitations are documented in each
+:ref:`project Release Notes <doc-releaserepos>`.
+
+.. index:: Reporting Bugs
+
+How to Report a Bug
+===================
+There are 2 ways to report a bug in ONAP.
+
+ * In case you are familiar within ONAP, you can directly report a bug by
+   creating a Jira issue at `ONAP Jira <https://jira.onap.org>`_.
+
+ * If you don't know you are facing a bug or have a question, post your
+   question into the `Ask question <https://wiki.onap.org/display/DW/questions/all>`_.
+   You will need a Linux Foundation ID to login and post your question.
+   Get a Linux Foundation Identity using this `quick procedure <https://wiki.onap.org/display/DW/Joining+the+ONAP+Technical+Community#JoiningtheONAPTechnicalCommunity-WhereDoIStart?>`_.
+
+To properly report a bug in Jira, you may want to consider these `recommendations <https://wiki.onap.org/display/DW/Tracking+Issues+with+JIRA#TrackingIssueswithJIRA-RecommendationsforwrittingProperJIRAIssue>`_ to elaborate the issue you are facing.
 
-.. toctree::
-   :maxdepth: 1
 
+.. Include files referenced by link in the toctree as hidden