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 This page is the ONAP Amsterdam Release Notes. The first release is Amsterdam and subsequent major release will be named using city names.
   7
   8 * Release Name: Amsterdam
   9 * Release Version: 1.0.0
  10 * Release Date: November 16, 2017
  11
  12
  13 Amsterdam Release
  14 -----------------
  15
  16 Summary
  17 +++++++
  18
  19 Functionality
  20 +++++++++++++
  21
  22
  23 Project Specific Release Notes
  24 ++++++++++++++++++++++++++++++
  25 ONAP releases are specified by a list of project artifact
  26 versions in a :ref:`manifest<doc-release-manifest>`.
  27 Each project provides detailed :ref:`release notes<doc-releaserepos>`
  28 and prepends to these if/when any updated versions the project team believes
  29 are compatible with a major release are made available.
  30
  31
  32 Supported Platforms
  33 +++++++++++++++++++
  34 ONAP Amsterdam Release has been tested on Ubuntu 16.04 and thus is the only OS supported.
  35
  36 Documentation
  37 +++++++++++++
  38 ONAP Amsterdam Release documentation is available :ref:`here <master_index>`.
  39 For Amsterdam this includes:
  40
  41 * A high level :ref:`architecture view<doc-architecture>` of how components
  42   relate to each other.
  43
  44 * A collection of documentation provided
  45   by :ref:`each project <doc_onap-developer_guide_projects>`.
  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 and
  51   community events. See the doc
  52   project :ref:`release notes <doc-release-notes>` for current status on documentation.
  53
  54
  55 Known Issues and Limitations
  56 ++++++++++++++++++++++++++++
  57 Known Issues and limitations are documented in each project Release Notes.
  58
  59 Refer to :ref:`release notes <doc-releaserepos>` for each project.
  60
  61 License
  62 +++++++
  63 ONAP Amsterdam is an `Apache Version 2 license <http://www.apache.org/licenses/LICENSE-2.0>`_ type of Open Source project.
  64
  65 How to Report a Bug
  66 +++++++++++++++++++
  67 There are 2 ways to report a bug in ONAP.
  68
  69 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>`_.
  70
  71 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 .
  72
  73 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.
  74
  75
  76 Download and Use
  77 ++++++++++++++++
  78
  79 * ONAP Source Code is available through Gerrit at https://gerrit.onap.org or Git at https://git.onap.org/ .
  80
  81 * ONAP is packaged within Docker and can be dowloaded from Docker Hub at https://hub.docker.com/r/onap .
  82
  83 * To Install Amsterdam ONAP refer to :ref:`Setting Up ONAP <demo-installing-running-onap>`.
  84