prepare montreal docs - config and release related files #1
[doc.git] / docs / release / index.rst
1 ..
2   This work is licensed under a Creative Commons Attribution 4.0
3   International License. http://creativecommons.org/licenses/by/4.0
4
5
6 .. _onap-release-notes:
7
8 'Montreal' Release Notes
9 ========================
10
11 This page provides the release notes for the ONAP 'Montreal' release. This
12 includes details of software versions, known limitations, and outstanding
13 trouble reports.
14
15 Release notes are cumulative for the release, meaning this release note will
16 have an entry for each Major, Minor, and 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 release by each component is
21 maintained in the component specific release notes.
22
23 'Montreal' Major Release 13.0.0
24 -------------------------------
25
26 +-----------------------------------+-----------------------------------------+
27 | **Project**                       | Open Network Automation Platform (ONAP) |
28 +-----------------------------------+-----------------------------------------+
29 | **Release name**                  | Montreal                                |
30 +-----------------------------------+-----------------------------------------+
31 | **Release version**               | 13.0.0                                  |
32 +-----------------------------------+-----------------------------------------+
33 | **Release date**                  | not released yet                        |
34 +-----------------------------------+-----------------------------------------+
35
36 Features
37 --------
38
39 ONAP 'Montreal' focusses on:
40
41 - to be done
42
43 Functional Requirements
44 -----------------------
45
46 tbd
47 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
48
49 - tbd
50
51 Non-Functional Requirements
52 ---------------------------
53
54 The 'non-functional' requirements of this release are:
55
56 Security
57 ^^^^^^^^
58
59 - tbd
60
61 Documentation
62 ^^^^^^^^^^^^^
63
64 - tbd
65
66 Tests & Integration
67 ^^^^^^^^^^^^^^^^^^^
68
69 - tbd
70
71 .. important::
72    Some non-functional requirements are not fully finalized. Please, check
73    details at :doc:`Integration <onap-integration:usecases/release_non_functional_requirements>`
74
75 Documentation Sources
76 ---------------------
77
78 The formal ONAP 'Montreal' Release Documentation is available
79 in :ref:`ReadTheDocs<master_index>`.
80
81 The `Developer Wiki <http://wiki.onap.org>`_ remains a good source of
82 information on meeting plans and notes from committees, project teams and
83 community events.
84
85 OpenSSF Best Practice
86 ---------------------
87
88 ONAP has adopted the `OpenSSF Best Practice Badge Program <https://bestpractices.coreinfrastructure.org/en>`_.
89
90 - `Badging Requirements <https://github.com/coreinfrastructure/best-practices-badge>`_
91 - `Badging Status for all ONAP projects <https://bestpractices.coreinfrastructure.org/en/projects?q=onap>`_
92
93 In the Montreal release,
94
95 - x% projects passed 90% of the OpenSSF badge
96 - x% passed the OpenSSF badge
97 - x% projects passed the OpenSSF Silver badge
98
99 Project specific details are in the :ref:`release notes<component-release-notes>`
100 for each component.
101
102 .. index:: maturity
103
104 ONAP Maturity Testing Notes
105 ---------------------------
106 For the 'Montreal' release, ONAP continues to improve in multiple areas of
107 Scalability, Security, Stability and Performance (S3P) metrics.
108
109 More details in :ref:`ONAP Integration Project<onap-integration:master_index>`
110
111 Known Issues and Limitations
112 ----------------------------
113 Known Issues and limitations are documented in each
114 :ref:`project Release Notes <component-release-notes>`.