Update git submodules
[doc.git] / docs / release / index.rst
1 .. This work is licensed under a Creative Commons Attribution 4.0
2    International License. http://creativecommons.org/licenses/by/4.0
3
4
5 .. _release-notes:
6
7 El Alto Release Notes
8 ^^^^^^^^^^^^^^^^^^^^^
9
10 This page provides the release notes for the ONAP El Alto release. This
11 includes details of software versions used, known limitations, and outstanding
12 trouble reports.
13
14 Release notes are cumulative for the release, meaning this release note for the
15 El Alto release will have an entry for each Major, Minor, and
16 Maintenance release, if applicable.
17
18 Each component within the ONAP solution maintains their own component level
19 release notes and links to those release notes are provided below.
20 Details on the specific items delivered in each releaese by each component is
21 maintained in the component specific release notes.
22
23 El Alto Major Release 5.0.1
24 ===========================
25
26 * Release Name: El Alto
27 * Release Version: 5.0.1
28 * Release Date: October 24 2019
29
30 Project Specific Release Notes
31 ==============================
32 ONAP releases are specified by a list of project artifact versions in the
33 project repositories and docker container image versions listed in the OOM
34 Helm charts.
35 Each project provides detailed :ref:`release notes<doc-releaserepos>`
36 and prepends to these if/when any updated versions the project team believes
37 are compatible with a major release are made available.
38
39 Documentation
40 =============
41 ONAP El Alto Release provides a set selection of documents,
42 see :ref:`ONAP Home<master_index>`.
43
44 The `developer wiki <http://wiki.onap.org>`_ remains a good source of
45 information on meeting plans and notes from committees, project teams and
46 community events.
47
48 Security Notes
49 ==============
50 Details about discovered and mitigated vulnerabilities are in
51 :ref:`ONAP Security <onap-security>`
52
53 .. toctree::
54    :hidden:
55
56    ../submodules/osa.git/docs/index.rst
57
58 ONAP has adopted the `CII Best Practice Badge Program <https://bestpractices.coreinfrastructure.org/en>`_.
59
60 - `Badging Requirements <https://github.com/coreinfrastructure/best-practices-badge#core-infrastructure-initiative-best-practices-badge>`_
61 - `Badging Status for all ONAP projects <https://bestpractices.coreinfrastructure.org/en/projects?q=onap>`_
62
63 Project specific details are in the :ref:`release notes<doc-releaserepos>` for
64 each project.
65
66 .. index:: maturity
67
68 ONAP Maturity Testing Notes
69 ===========================
70 For El Alto release, ONAP continues to improve in multiple areas of
71 Scalability, Security, Stability and Performance (S3P) metrics.
72
73 The Integration team ran the 72 hours stability testing (100% passing rate)
74 and full resilience testing (99.4% passing rate) at ONAP OpenLabs. More details
75 in :ref:`ONAP Maturity Testing Notes <integration-s3p>`
76
77 Known Issues and Limitations
78 ============================
79 Known Issues and limitations are documented in each
80 :ref:`project Release Notes <doc-releaserepos>`.
81
82 .. index:: Reporting Bugs
83
84 How to Report a Bug
85 ===================
86 There are 2 ways to report a bug in ONAP.
87
88  * In case you are familiar within ONAP, you can directly report a bug by
89    creating a Jira issue at `ONAP Jira <https://jira.onap.org>`_.
90
91  * If you don't know you are facing a bug or have a question, post your
92    question into the `Ask question <https://wiki.onap.org/display/DW/questions/all>`_.
93    You will need a Linux Foundation ID to login and post your question.
94    Get a Linux Foundation Identity using this `quick procedure <https://wiki.onap.org/display/DW/Joining+the+ONAP+Technical+Community#JoiningtheONAPTechnicalCommunity-WhereDoIStart?>`_.
95
96 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.
97
98
99 .. Include files referenced by link in the toctree as hidden