Merge "Update Master Release Notes"
[doc.git] / docs / release / index.rst
index 03ffc1f..73af733 100644 (file)
@@ -1,36 +1,84 @@
-.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. This work is licensed under a Creative Commons Attribution 4.0
+   International License. http://creativecommons.org/licenses/by/4.0
 
+Releases
+========
+This page is the ONAP Amsterdam Release Notes. The first release is Amsterdam and subsequent major release will be named using city names.
 
-Release
-=======
+* Release Name: Amsterdam
+* Release Version: 1.0.0
+* Release Date: November 16, 2017
 
-Overview of use cases, installation, release notes, etc.
 
+Amsterdam Release
+-----------------
 
-Architecture
-------------
+Summary
++++++++
 
+Functionality
++++++++++++++
 
-Use Cases
----------
 
+Project Specific Release Notes
+++++++++++++++++++++++++++++++
+ONAP releases are specified by a list of project artifact
+versions in a :ref:`manifest<doc-release-manifest>`.
+Each project provides detailed :ref:`release notes<doc-releaserepos>`
+and prepends to these if/when any updated versions the project team believes
+are compatible with a major release are made available.
 
-Tutorials
----------
 
+Supported Platforms
++++++++++++++++++++
+ONAP Amsterdam Release has been tested on Ubuntu 16.04 and thus is the only OS supported.
 
+Documentation
++++++++++++++
+ONAP Amsterdam Release documentation is available :ref:`here <master_index>`.
+For Amsterdam this includes:
 
-Release Notes
--------------
+* A high level :ref:`architecture view<doc-architecture>` of how components
+  relate to each other.
 
-Projects Providing Documentation
---------------------------------
+* A collection of documentation provided
+  by :ref:`each project <doc_onap-developer_guide_projects>`.
 
-.. toctree::
-   :maxdepth: 1
+* Application Programming Interface Reference :ref:`available here <doc-apiref>`.
 
-   repolist.rst
+* The `developer wiki <http://wiki.onap.org>`_ remains a good source of
+  information on meeting plans and notes from committees, project teams and
+  community events. See the doc
+  project :ref:`release notes <doc-release-notes>` for current status on documentation.
 
 
+Known Issues and Limitations
+++++++++++++++++++++++++++++
+Known Issues and limitations are documented in each project Release Notes.
 
+Refer to :ref:`release notes <doc-releaserepos>` for each project.
+
+License
++++++++
+ONAP Amsterdam is an `Apache Version 2 license <http://www.apache.org/licenses/LICENSE-2.0>`_ type of Open Source project.
+
+How to Report a Bug
++++++++++++++++++++
+There are 2 ways to report a bug in ONAP.
+
+In case you are familiar within ONAP, you can directly report a bug by creating a Jira issue at `ONAP Jira <https://jira.onap.org>`_.
+
+If you don't know you are facing a bug or have a question, email the ONAP Discuss mailing list at onap-discuss@lists.onap.org .
+
+You may consider these `recommendations <https://wiki.onap.org/display/DW/Tracking+Issues+with+JIRA#TrackingIssueswithJIRA-RecommendationsforwrittingProperJIRAIssue>`_ to elaborate the issue you are facing and this `guideline <https://wiki.onap.org/display/DW/Mailing+Lists>`_ to register into the ONAP Discuss mailing list.
+
+
+Download and Use
+++++++++++++++++
+
+* ONAP Source Code is available through Gerrit at https://gerrit.onap.org or Git at https://git.onap.org/ .
+
+* ONAP is packaged within Docker and can be dowloaded from Docker Hub at https://hub.docker.com/r/onap .
+
+* To Install Amsterdam ONAP refer to :ref:`Setting Up ONAP <demo-installing-running-onap>`.