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