From 65bec69096b0a2ef18cd72d87b89757da4ae1906 Mon Sep 17 00:00:00 2001 From: thmsdt Date: Thu, 11 Aug 2022 13:05:18 +0200 Subject: improve navigation and readability Issue-ID: DOC-798 Signed-off-by: thmsdt Change-Id: Ib4f8246d548a77885c5f6c5457ce2c3b20e275b6 --- docs/release/component-release-notes.rst | 112 +++++++++++++++++++++++++++++++ docs/release/history.rst | 35 ++++++++++ docs/release/index.rst | 6 +- docs/release/releaserepos.rst | 112 ------------------------------- 4 files changed, 150 insertions(+), 115 deletions(-) create mode 100644 docs/release/component-release-notes.rst create mode 100644 docs/release/history.rst delete mode 100644 docs/release/releaserepos.rst (limited to 'docs/release') diff --git a/docs/release/component-release-notes.rst b/docs/release/component-release-notes.rst new file mode 100644 index 000000000..34b0b6942 --- /dev/null +++ b/docs/release/component-release-notes.rst @@ -0,0 +1,112 @@ +.. This work is licensed under a Creative Commons Attribution +.. 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. Copyright 2017 AT&T Intellectual Property. All rights reserved. + +.. _component-release-notes: + +:orphan: + +Component Release Notes +======================= + +ONAP releases are specified by a list of project artifact versions in the +project repositories and Docker container image versions listed in the OOM +Helm charts. Each project provides detailed release notes and prepends to these +if/when any updated versions the project team believes are compatible with a +major release are made available. + +AAI - Active and Available Inventory +------------------------------------ +- :ref:`aai/common ` + +CCSDK - Common Controller Software Development Kit +-------------------------------------------------- +- :ref:`ccsdk/cds ` +- :ref:`ccsdk/distribution ` +- :ref:`ccsdk/oran ` + +CLI - Command Line Interface +---------------------------- +- :ref:`cli ` + +CPS - Configuration Persistence Service +--------------------------------------- +- :ref:`cps ` +- :ref:`cps/cps-temporal ` +- :ref:`cps/ncmp-dmi-plugin ` + +DCAE Gen.2 - Data Collection, Analysis and Events +------------------------------------------------- +- :ref:`dcaegen2 ` + +DMAAP - Data Movement As A Platform +----------------------------------- +- :ref:`dmaap/buscontroller ` +- :ref:`dmaap/datarouter ` +- :ref:`dmaap/messagerouter/messageservice ` + +DOC - Documentation +------------------- +- :ref:`doc ` + +HOLMES - Holmes +--------------- +- :ref:`holmes/rule-management ` + +INT - Integration +----------------- +- :ref:`integration ` + +MODELING - Modeling +------------------- +- :ref:`modeling/etsicatalog ` +- :ref:`modeling/modelspec ` + +MSB - Microservices Bus +----------------------- +- :ref:`msb/apigateway ` + +MULTICLOUD - Multi Cloud +------------------------ +- :ref:`multicloud/framework ` + +OOF - Optimization Framework +---------------------------- +- :ref:`optf/has ` +- :ref:`optf/osdf ` + +OOM - ONAP Operations Manager +----------------------------- +- :ref:`oom ` +- :ref:`oom/platform/cert-service ` + +.. - :ref:`oom/offline-installer ` ### changelog file needs at least the anchor / combine CL & RL? + +POLICY - Policy Framework +------------------------- +- :ref:`policy/parent ` + +SDC - Service Design & Creation +------------------------------- +- :ref:`sdc ` + +SDNC - Software Defined Network Controller +------------------------------------------ +- :ref:`sdnc/oam ` + +SO - Service Orchestration +-------------------------- +- :ref:`so ` + +UUI - Use Case User Interface +----------------------------- +- :ref:`usecase-ui ` + +VFC - Virtual Function Controller +--------------------------------- +- :ref:`vfc/nfvo/lcm ` + +VNFSDK - VNF Software Development Kit +------------------------------------- +- :ref:`vnfsdk/model ` diff --git a/docs/release/history.rst b/docs/release/history.rst new file mode 100644 index 000000000..e1a97cd50 --- /dev/null +++ b/docs/release/history.rst @@ -0,0 +1,35 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 + International License. http://creativecommons.org/licenses/by/4.0 + Copyright 2022 by ONAP and contributors. + +.. _release-history: + +ONAP Release History +-------------------- + +ONAP is enhanced with numerous features from release to release. Each release +is named after a city. + ++-----------------+-----------------+------------------------+ +| Release Name | Release Version | Release Date | ++=================+=================+========================+ +| Jakarta | 10.0.0 | 2022, June 30th | ++-----------------+-----------------+------------------------+ +| Istanbul | 9.0.0 | 2021, November 15th | ++-----------------+-----------------+------------------------+ +| Honolulu | 8.0.0 | 2021, May 11th | ++-----------------+-----------------+------------------------+ +| Guilin | 7.0.0 | 2020, December 3rd | ++-----------------+-----------------+------------------------+ +| Frankfurt | 6.0.0 | 2020, June 11th | ++-----------------+-----------------+------------------------+ +| El Alto | 5.0.0 | 2019, October 24th | ++-----------------+-----------------+------------------------+ +| Dublin | 4.0.0 | 2019, July 9th | ++-----------------+-----------------+------------------------+ +| Casablanca | 3.0.0 | 2019, April 15th | ++-----------------+-----------------+------------------------+ +| Beijing | 2.0.0 | 2018, June 7th | ++-----------------+-----------------+------------------------+ +| Amsterdam | 1.0.0 | 2017, November 16th | ++-----------------+-----------------+------------------------+ \ No newline at end of file diff --git a/docs/release/index.rst b/docs/release/index.rst index 35e4d339a..fb66c1327 100644 --- a/docs/release/index.rst +++ b/docs/release/index.rst @@ -280,8 +280,8 @@ In the Jakarta release, - 85% projects passed the CII badge - 11% projects passed the CII Silver badge -Project specific details are in the :ref:`release notes` for -each project. +Project specific details are in the :ref:`release notes` +for each component. .. index:: maturity @@ -300,4 +300,4 @@ More details in :ref:`ONAP Integration Project` Known Issues and Limitations ---------------------------- Known Issues and limitations are documented in each -:ref:`project Release Notes `. +:ref:`project Release Notes `. diff --git a/docs/release/releaserepos.rst b/docs/release/releaserepos.rst deleted file mode 100644 index 1f102ff3f..000000000 --- a/docs/release/releaserepos.rst +++ /dev/null @@ -1,112 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution -.. 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 -.. Copyright 2017 AT&T Intellectual Property. All rights reserved. - -.. _doc-releaserepos: - -:orphan: - -Project Specific Release Notes -============================== - -ONAP releases are specified by a list of project artifact versions in the -project repositories and Docker container image versions listed in the OOM -Helm charts. Each project provides detailed release notes and prepends to these -if/when any updated versions the project team believes are compatible with a -major release are made available. - -AAI - Active and Available Inventory ------------------------------------- -- :ref:`aai/common ` - -CCSDK - Common Controller Software Development Kit --------------------------------------------------- -- :ref:`ccsdk/cds ` -- :ref:`ccsdk/distribution ` -- :ref:`ccsdk/oran ` - -CLI - Command Line Interface ----------------------------- -- :ref:`cli ` - -CPS - Configuration Persistence Service ---------------------------------------- -- :ref:`cps ` -- :ref:`cps/cps-temporal ` -- :ref:`cps/ncmp-dmi-plugin ` - -DCAE Gen.2 - Data Collection, Analysis and Events -------------------------------------------------- -- :ref:`dcaegen2 ` - -DMAAP - Data Movement As A Platform ------------------------------------ -- :ref:`dmaap/buscontroller ` -- :ref:`dmaap/datarouter ` -- :ref:`dmaap/messagerouter/messageservice ` - -DOC - Documentation -------------------- -- :ref:`doc ` - -HOLMES - Holmes ---------------- -- :ref:`holmes/rule-management ` - -INT - Integration ------------------ -- :ref:`integration ` - -MODELING - Modeling -------------------- -- :ref:`modeling/etsicatalog ` -- :ref:`modeling/modelspec ` - -MSB - Microservices Bus ------------------------ -- :ref:`msb/apigateway ` - -MULTICLOUD - Multi Cloud ------------------------- -- :ref:`multicloud/framework ` - -OOF - Optimization Framework ----------------------------- -- :ref:`optf/has ` -- :ref:`optf/osdf ` - -OOM - ONAP Operations Manager ------------------------------ -- :ref:`oom ` -- :ref:`oom/platform/cert-service ` - -.. - :ref:`oom/offline-installer ` ### changelog file needs at least the anchor / combine CL & RL? - -POLICY - Policy Framework -------------------------- -- :ref:`policy/parent ` - -SDC - Service Design & Creation -------------------------------- -- :ref:`sdc ` - -SDNC - Software Defined Network Controller ------------------------------------------- -- :ref:`sdnc/oam ` - -SO - Service Orchestration --------------------------- -- :ref:`so ` - -UUI - Use Case User Interface ------------------------------ -- :ref:`usecase-ui ` - -VFC - Virtual Function Controller ---------------------------------- -- :ref:`vfc/nfvo/lcm ` - -VNFSDK - VNF Software Development Kit -------------------------------------- -- :ref:`vnfsdk/model ` -- cgit 1.2.3-korg