From ab6162b2d28e00f8ed802fc168b48a853d24e3d6 Mon Sep 17 00:00:00 2001 From: Eric Debeau Date: Fri, 17 Nov 2017 19:30:47 +0000 Subject: [PATCH] Update release note Actions according to dedicated doc meeting Reword release notes download and install sections Move some sections Change-Id: I359764d1c6bca549eff5282401d1b134c36ae2e1 Issue-ID: DOC-150 Signed-off-by: Eric Debeau --- docs/release/index.rst | 85 +++++++++++++++++++++++++------------------------- 1 file changed, 42 insertions(+), 43 deletions(-) diff --git a/docs/release/index.rst b/docs/release/index.rst index bc4ee5674..4e552d76b 100644 --- a/docs/release/index.rst +++ b/docs/release/index.rst @@ -95,12 +95,39 @@ Each project provides detailed :ref:`release notes` and prepends to these if/when any updated versions the project team believes are compatible with a major release are made available. - Supported Platforms +++++++++++++++++++ ONAP Amsterdam Release has been tested on Ubuntu 16.04 and thus is the only OS supported. +.. index:: Download + +Download & Install +++++++++++++++++++ +There are 3 approaches to install ONAP: + +* Full ONAP installation using Heat template +* Advanced installation to install individual components +* Experimental installation using Kubernetes + +Full ONAP installation using Heat template +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +From a complete demo solution perspective. This installs the whole ONAP, + refer to :ref:`Setting Up ONAP `. + +Advanced installation to install individual components +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +From a developer perspective. ONAP can be installed component per component: + :ref:`installation is listed in `. + +* The list of ports used by default within ONAP is documented in `ONAP Service List `_. +* The 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. + +Experimental installation using Kubernetes +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +From a complete demo solution perspective using Kubernetes. This installs the whole ONAP, refer to `ONAP Operations Manager - Quick Start Guide `_. + Documentation +++++++++++++ ONAP Amsterdam Release documentation is available :ref:`here `. @@ -119,13 +146,15 @@ For Amsterdam this includes: information on meeting plans and notes from committees, project teams and community events. +Usage ++++++ +This section is intended to provide users on the usage of ONAP components. -Known Issues and Limitations -++++++++++++++++++++++++++++ -Known Issues and limitations are documented in each project Release Notes. - -Refer to :ref:`release notes ` for each project. - +Instructions on using the ONAP deployment including Robot, Portal, SDC and VID +in the context of running (Onboarding, service creation, service deployment, +VNF creation, VNF preload, VF Module creation and closed loop operations) +the vFirewall sanity use case is documented +in `Running the ONAP Demos `_. .. index:: Licensing @@ -134,6 +163,12 @@ Licenses ONAP Amsterdam Source Code is licensed under the `Apache Version 2 License `_. ONAP Amsterdam Documentation is licensed under the `Creative Commons Attribution 4.0 International License `_. +Known Issues and Limitations +++++++++++++++++++++++++++++ +Known Issues and limitations are documented in each project Release Notes. + +Refer to :ref:`release notes ` for each project. + .. index:: Reporting Bugs How to Report a Bug @@ -149,42 +184,6 @@ There are 2 ways to report a bug in ONAP. You may consider these `recommendations `_ to elaborate the issue you are facing and this `guideline `_ to register into the ONAP Discuss mailing list. -.. index:: Download - -Download -++++++++ - -* 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 . - - -.. index:: Installation - - -Install -+++++++ -There are 2 approaches to install ONAP. - -* From a complete demo solution perspective. This installs the whole ONAP, - refer to :ref:`Setting Up ONAP `. - -* From a developer perspective. ONAP is installed component per component. - Each - component :ref:`installation is listed in`. - The list of ports used by default within ONAP is documented - in `ONAP Service List `_. - -Usage -+++++ -This section is intended to provide users on the usage of ONAP components. - -Instructions on using the ONAP deployment including Robot, Portal, SDC and VID -in the context of running (Onboarding, service creation, service deployment, -VNF creation, VNF preload, VF Module creation and closed loop operations) -the vFirewall sanity use case is documented -in `Running the ONAP Demos `_. - .. Include files referenced by link in the toctree as hidden -- 2.16.6