X-Git-Url: https://gerrit.onap.org/r/gitweb?a=blobdiff_plain;f=docs%2Frelease%2Findex.rst;h=8ef20ea0e40f16b39b3ecfeffcf8767d28594da1;hb=818eec93cb59d7bfe9c76fb61e9ce422d3b046bd;hp=bfd896f7c08db4ae02ebb4049d926e77b815510d;hpb=d1f094919f1558d05f5aa72e209ad9359135bcf4;p=doc.git diff --git a/docs/release/index.rst b/docs/release/index.rst index bfd896f7c..8ef20ea0e 100644 --- a/docs/release/index.rst +++ b/docs/release/index.rst @@ -1,32 +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 +======== +ONAP is developed and released around 6 month cycles. After an initial +major release, additional stable point releases may be created. The first +release is Amsterdam and subsequent major release will be named using city +names. -Release -======= -Overview of use cases, installation, release notes, etc. +Amsterdam Release +----------------- +Summary ++++++++ -Architecture ------------- +Functionality ++++++++++++++ -Use Cases ---------- +Project Specific Release Notes +++++++++++++++++++++++++++++++ +Major and stable point releases are specified by a list of project artifact +versions in a :ref:`manifest`. +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. -Tutorials ---------- +Supported Platforms ++++++++++++++++++++ +Documentation ++++++++++++++ +Release controlled documentation is available :ref:`here `. +For Amsterdam this includes: -Release Notes -------------- +* A high level :ref:`architecture view` of how components + relate to each other. +* A collection of documentation provided + by :ref:`each project `. -Component Specific Notes -++++++++++++++++++++++++ +* Application Programming Interface Reference :ref:`available here ` -.. toctree:: - :maxdepth: 1 +* The `developer wiki `_ remains a good source of + information on meeting plans and notes from committees, project teams, + community events and general, release independent information about + ONAP. Release dependent information is being migrated from the wiki to + gerrit source control. See the doc + project :ref:`release notes ` for current status. + + +Known Issues and Limitations +++++++++++++++++++++++++++++ +TBP overall / general statement +See :ref:`release notes ` for each project. + +License ++++++++ + + +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 `_. + +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 `_ to elaborate the issue you are facing and this `guideline `_ to register into the ONAP Discuss mailing list. + + +Download and Use +++++++++++++++++ + +* Source Code in Gerrit https://gerrit.onap.org + +* Artifacts in Nexus / Docker Hub + +* Platform :ref:`Demo `.