Multiple editorial improvements
[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 here<doc-release-manifest>`.
26 Each project provides detailed :ref:`release notes here <doc-releaserepos>`
27 and prepends to these if/when any updated versions, the project team believes
28 are compatible with 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 architecture view of how components delivered by all projects
41   relate to each other are :ref:`available here <doc-architecture>`.
42
43 * A collection of documentation provided by each project and for some projects
44   several components / repositories within the project
45   are :ref:`available here <doc-repolist>`.
46
47 * Application Programming Interface Reference :ref:`available here <doc-apiref>`
48
49 * The `developer wiki <http://wiki.onap.org>`_ remains a good source of
50   information on meeting plans and notes from committees, project teams,
51   community events and general, release independent information about
52   ONAP.  Release dependent information is being migrated from the wiki to
53   gerrit source control. See the doc
54   project :ref:`release notes <doc-release-notes>` for current status.
55
56
57 Known Issues and Limitations
58 ++++++++++++++++++++++++++++
59 TBP overall / general statement
60 See :ref:`release notes <doc-releaserepos>` for each project.
61
62 License
63 +++++++
64
65
66 How to Report a Bug
67 +++++++++++++++++++
68
69
70 Download and Use
71 ++++++++++++++++
72
73 * Source Code in Gerrit https://gerrit.onap.org
74
75 * Artifacts in Nexus / Docker Hub
76
77 * Platform :ref:`Demo <demo-installing-running-onap>`.
78