Merge "Integrate architecture overview"
[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 Releases
5 ========
6 ONAP is developed and released around 6 month cycles. After an initial
7 major release, additional stable point releases may be created.  The first
8 release is Amsterdam and subsequent major release will be named using city
9 names.
10
11
12 Amsterdam Release
13 -----------------
14
15 Summary
16 +++++++
17
18 Functionality
19 +++++++++++++
20
21
22 Project Specific Release Notes
23 ++++++++++++++++++++++++++++++
24 Major and stable point releases are specified by a list of project artifact
25 versions in a :ref:`manifest<doc-release-manifest>`.
26 Each project provides detailed :ref:`release notes<doc-releaserepos>`
27 and prepends to these if/when any updated versions the project team believes
28 are compatible with a major release are made available.
29
30
31 Supported Platforms
32 +++++++++++++++++++
33
34
35 Documentation
36 +++++++++++++
37 Release controlled documentation is available :ref:`here <master_index>`.
38 For Amsterdam this includes:
39
40 * A high level :ref:`architecture view<doc-architecture>` of how components
41   relate to each other.
42
43 * A collection of documentation provided
44   by :ref:`each project <doc_onap-developer_guide_projects>`.
45
46 * Application Programming Interface Reference :ref:`available here <doc-apiref>`
47
48 * The `developer wiki <http://wiki.onap.org>`_ remains a good source of
49   information on meeting plans and notes from committees, project teams,
50   community events and general, release independent information about
51   ONAP.  Release dependent information is being migrated from the wiki to
52   gerrit source control. See the doc
53   project :ref:`release notes <doc-release-notes>` for current status.
54
55
56 Known Issues and Limitations
57 ++++++++++++++++++++++++++++
58 TBP overall / general statement
59 See :ref:`release notes <doc-releaserepos>` for each project.
60
61 License
62 +++++++
63
64
65 How to Report a Bug
66 +++++++++++++++++++
67
68
69 Download and Use
70 ++++++++++++++++
71
72 * Source Code in Gerrit https://gerrit.onap.org
73
74 * Artifacts in Nexus / Docker Hub
75
76 * Platform :ref:`Demo <demo-installing-running-onap>`.
77