Update git submodules
[doc.git] / docs / release / index.rst
index 7d21f38..453d7c1 100644 (file)
 .. This work is licensed under a Creative Commons Attribution 4.0
    International License. http://creativecommons.org/licenses/by/4.0
 
-Releases
-========
-This page is the ONAP Amsterdam Release Notes. The first release is Amsterdam and subsequent major release will be named using city names.
 
-* Release Name: Amsterdam
-* Release Version: 1.0.0
-* Release Date: November 16, 2017
+.. _release-notes:
 
+El Alto Release Notes
+^^^^^^^^^^^^^^^^^^^^^
 
-Amsterdam Release
------------------
+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.
 
-Summary
-+++++++
-ONAP provides a comprehensive platform for real-time, policy-driven
-orchestration and automation of physical and virtual network functions
-that will enable software, network, IT and cloud providers and developers
-to rapidly automate new services and support complete life cycle management.
-By unifying member resources, ONAP will accelerate the development of a
-vibrant ecosystem around a globally shared architecture and implementation
-for network automation–with an open standards focus–faster than any one
-product could on its own.
+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.
 
-Functionality
-+++++++++++++
+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.
 
+El Alto Major Release 5.0.1
+===========================
+
+* Release Name: El Alto
+* Release Version: 5.0.1
+* Release Date: October 24 2019
 
 Project Specific Release Notes
-++++++++++++++++++++++++++++++
-ONAP releases are specified by a list of project artifact
-versions in a :ref:`manifest<doc-release-manifest>`.
+==============================
+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.
 
-
-Supported Platforms
-+++++++++++++++++++
-ONAP Amsterdam Release has been tested on Ubuntu 16.04 and thus is the only OS supported.
-
 Documentation
-+++++++++++++
-ONAP Amsterdam Release documentation is available :ref:`here <master_index>`.
-For Amsterdam this includes:
-
-* A high level :ref:`architecture view<doc-architecture>` of how components
-  relate to each other.
-
-* A collection of documentation provided
-  by :ref:`each project <doc_onap-developer_guide_projects>`.
-
-* Application Programming Interface Reference :ref:`available here <doc-apiref>`.
+=============
+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.
+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-security>`
 
-Known Issues and Limitations
-++++++++++++++++++++++++++++
-Known Issues and limitations are documented in each project Release Notes.
+.. toctree::
+   :hidden:
 
-Refer to :ref:`release notes <doc-releaserepos>` for each project.
+   ../submodules/osa.git/docs/index.rst
 
-Licenses
-++++++++
-ONAP Amsterdam Source Code is licensed under the `Apache Version 2 License <http://www.apache.org/licenses/LICENSE-2.0>`_.
-ONAP Amsterdam Documentation is licensed under the `Creative Commons Attribution 4.0 International License <http://creativecommons.org/licenses/by/4.0>`_.
+ONAP has adopted the `CII Best Practice Badge Program <https://bestpractices.coreinfrastructure.org/en>`_.
 
-How to Report a Bug
-+++++++++++++++++++
-There are 2 ways to report a bug in ONAP.
+- `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>`_
 
-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>`_.
+Project specific details are in the :ref:`release notes<doc-releaserepos>` for
+each project.
 
-If you don't know you are facing a bug or have a question, email the ONAP Discuss mailing list at onap-discuss@lists.onap.org .
+.. index:: maturity
 
-You may consider these `recommendations <https://wiki.onap.org/display/DW/Tracking+Issues+with+JIRA#TrackingIssueswithJIRA-RecommendationsforwrittingProperJIRAIssue>`_ to elaborate the issue you are facing and this `guideline <https://wiki.onap.org/display/DW/Mailing+Lists>`_ to register into the ONAP Discuss mailing list.
+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>`
 
-Download
-++++++++
+Known Issues and Limitations
+============================
+Known Issues and limitations are documented in each
+:ref:`project Release Notes <doc-releaserepos>`.
 
-* ONAP Source Code is available through Gerrit at https://gerrit.onap.org or Git at https://git.onap.org/ .
+.. index:: Reporting Bugs
 
-* ONAP is packaged within Docker and can be dowloaded from Docker Hub at https://hub.docker.com/r/onap .
+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>`_.
 
-Install
-+++++++
-There are 2 approaches to install ONAP.
+ * 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?>`_.
 
-* From a complete demo solution perspective. This installs the whole ONAP, refer to :ref:`Setting Up ONAP <demo-installing-running-onap>`.
+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.
 
-* From a developer perspective. ONAP is installed component per component. Each component :ref:`installation is listed in<doc_onap-developer_guide_projects>`.
-The list of ports used by default within ONAP is documented in `ONAP Service List <https://wiki.onap.org/display/DW/ONAP+Services+List>`_.
 
-Usage
-+++++
-This section is intended to provide users on the usage of ONAP components.
+.. Include files referenced by link in the toctree as hidden