From dce166f9201df2f19104cf9fe99bd70173f39cc3 Mon Sep 17 00:00:00 2001 From: Eric Debeau Date: Wed, 6 Jun 2018 13:41:26 +0000 Subject: [PATCH] Update naming of projet Provide consistency in the naming of projects Inlcudes change from https://gerrit.onap.org/r/#/c/50521/1 Issue-ID: DOC-269 Change-Id: I06f484c0c591b76326e0449f9a8f2d5778fe45da Signed-off-by: Eric Debeau --- docs/guides/onap-developer/developing/index.rst | 49 ++++++++--------- docs/guides/onap-developer/settingup/index.rst | 2 +- .../onap-developer/settingup/onap_individual.rst | 4 -- docs/guides/onap-developer/settingup/onap_oom.rst | 14 ++--- docs/release/index.rst | 6 +-- docs/release/releaserepos.rst | 61 +++++++++++----------- 6 files changed, 64 insertions(+), 72 deletions(-) diff --git a/docs/guides/onap-developer/developing/index.rst b/docs/guides/onap-developer/developing/index.rst index 331248c2f..d856ee4a1 100644 --- a/docs/guides/onap-developer/developing/index.rst +++ b/docs/guides/onap-developer/developing/index.rst @@ -1,4 +1,5 @@ -.. 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 .. Copyright 2017 AT&T Intellectual Property. All rights reserved. @@ -33,6 +34,16 @@ Application Controller ../../../submodules/appc/deployment.git/docs/index ../../../submodules/appc.git/docs/index +Command Line Interface +---------------------- + +.. toctree:: + :maxdepth: 2 + :titlesonly: + + ../../../submodules/cli.git/docs/index + + Closed Loop Automation Platform ------------------------------- @@ -119,8 +130,8 @@ Integration * ONAP Amsterdam release content is specified within a list of project artifact versions available in the form of a :ref:`manifest`. * To install the whole ONAP (from a complete demo solution perspective) refer to :ref:`Setting Up ONAP `. -Logging Enhancements Project ----------------------------- +Logging Analytics +----------------- .. toctree:: :maxdepth: 2 @@ -171,18 +182,8 @@ Music ../../../submodules/music.git/docs/index - -ONAP Command Line Interface ---------------------------- - -.. toctree:: - :maxdepth: 2 - :titlesonly: - - ../../../submodules/cli.git/docs/index - -ONAP Operations Manager (experimental) --------------------------------------- +ONAP Operations Manager +----------------------- .. toctree:: :maxdepth: 2 @@ -190,15 +191,6 @@ ONAP Operations Manager (experimental) ../../../submodules/oom.git/docs/index -ONAP Use Case User Interface ----------------------------- - -.. toctree:: - :maxdepth: 2 - :titlesonly: - - ../../../submodules/usecase-ui.git/docs/index - Policy Framework ---------------- @@ -262,6 +254,15 @@ Software Defined Network Controller ../../../submodules/sdnc/parent.git/docs/index ../../../submodules/sdnc/plugins.git/docs/index +Use Case User Interface +----------------------- + +.. toctree:: + :maxdepth: 2 + :titlesonly: + + ../../../submodules/usecase-ui.git/docs/index + User Interface Applications --------------------------- diff --git a/docs/guides/onap-developer/settingup/index.rst b/docs/guides/onap-developer/settingup/index.rst index dc7d02bfe..d905a79c8 100644 --- a/docs/guides/onap-developer/settingup/index.rst +++ b/docs/guides/onap-developer/settingup/index.rst @@ -30,7 +30,7 @@ The various installations can be found here: .. toctree:: :maxdepth: 1 :titlesonly: - + onap_oom.rst onap_heat.rst onap_individual.rst diff --git a/docs/guides/onap-developer/settingup/onap_individual.rst b/docs/guides/onap-developer/settingup/onap_individual.rst index 065dcfd29..a3a1b5bc7 100644 --- a/docs/guides/onap-developer/settingup/onap_individual.rst +++ b/docs/guides/onap-developer/settingup/onap_individual.rst @@ -4,10 +4,6 @@ .. Copyright 2017-2018 ONAP -.. contents:: - :depth: 2 -.. - .. index:: Setting Up ONAP individual components diff --git a/docs/guides/onap-developer/settingup/onap_oom.rst b/docs/guides/onap-developer/settingup/onap_oom.rst index 28dd6ceba..7cb0d93a8 100644 --- a/docs/guides/onap-developer/settingup/onap_oom.rst +++ b/docs/guides/onap-developer/settingup/onap_oom.rst @@ -3,14 +3,8 @@ .. http://creativecommons.org/licenses/by/4.0 .. Copyright 2018 ONAP - -.. contents:: - :depth: 2 -.. - .. index:: Setting Up Full ONAP using Containers - ========================================= **Setting Up Full ONAP using Containers** ========================================= @@ -25,21 +19,21 @@ components using containers. You must use the following version for the various sofware components. - =========== ======= + =========== ========= Software Version - =========== ======= + =========== ========= Kubernetes 1.8.10 Helm 2.8.2 kubectl 1.8.10 Docker 17.03.x - =========== ======= + =========== ========= Creation of Kubernetes cluster is described here: .. toctree:: :maxdepth: 1 :titlesonly: - + ../../../../submodules/oom.git/docs/oom_cloud_setup_guide.rst diff --git a/docs/release/index.rst b/docs/release/index.rst index 45cec45d6..b4190ad8a 100644 --- a/docs/release/index.rst +++ b/docs/release/index.rst @@ -17,7 +17,7 @@ Amsterdam and subsequent major release will be named using city names. Getting Started With ONAP -========================== +========================= Summary ------- @@ -118,8 +118,8 @@ are compatible with a major release are made available. .. index:: Download -Download & Install -================== +Installation +============ There are 3 approaches to install ONAP: * :ref:`Installation using Kubernetes (aka OOM) `. Recommended method. diff --git a/docs/release/releaserepos.rst b/docs/release/releaserepos.rst index 7c5efec0e..9127314b0 100644 --- a/docs/release/releaserepos.rst +++ b/docs/release/releaserepos.rst @@ -1,4 +1,5 @@ -.. 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 .. Copyright 2017 AT&T Intellectual Property. All rights reserved. @@ -7,7 +8,8 @@ Project Specific Release Notes ++++++++++++++++++++++++++++++ -Each project is listed below followed by the Gerrit repositories in which there are release notes. +Each project is listed below followed by the Gerrit repositories in which +there are release notes. Active and Available Inventory ------------------------------ @@ -45,6 +47,15 @@ Common Controller Software Development Kit ccsdk<../submodules/ccsdk/distribution.git/docs/release-notes.rst> +Command Line Interface +---------------------- + +.. toctree:: + :maxdepth: 1 + :titlesonly: + + cli<../submodules/cli.git/docs/release-notes.rst> + Closed Loop Automation Platform ------------------------------- @@ -83,7 +94,7 @@ Data Management as a Platform Message Router dmaap<../submodules/dmaap/messagerouter/messageservice.git/docs/release-notes/release-notes.rst> External API / NBI ------- +------------------ .. toctree:: :maxdepth: 1 @@ -100,8 +111,8 @@ Holmes holmes<../submodules/holmes/rule-management.git/docs/release-notes.rst> -Logging Enhancements Project ----------------------------- +Logging Analytics +----------------- .. toctree:: :maxdepth: 1 @@ -146,16 +157,6 @@ Music music<../submodules/music.git/docs/release-notes.rst> - -ONAP Command Line Interface ---------------------------- - -.. toctree:: - :maxdepth: 1 - :titlesonly: - - cli<../submodules/cli.git/docs/release-notes.rst> - ONAP Operations Manager ----------------------- @@ -165,23 +166,14 @@ ONAP Operations Manager oom<../submodules/oom.git/docs/release-notes.rst> -ONAP Optimization Framework ---------------------------- - -.. toctree:: - :maxdepth: 1 - :titlesonly: - - oof<../submodules/optf/osdf.git/docs/sections/release-notes.rst> - -ONAP Use Case User Interface ----------------------------- +Optimization Framework +---------------------- .. toctree:: :maxdepth: 1 :titlesonly: - usecase-ui<../submodules/usecase-ui.git/docs/release-notes.rst> + optf<../submodules/optf/osdf.git/docs/sections/release-notes.rst> Policy Framework ---------------- @@ -210,6 +202,15 @@ Service Design & Creation sdc<../submodules/sdc.git/docs/release-notes.rst> +Service Orchestration +--------------------- + +.. toctree:: + :maxdepth: 1 + :titlesonly: + + so<../submodules/so.git/docs/release-notes.rst> + Software Defined Network Controller ----------------------------------- @@ -219,14 +220,14 @@ Software Defined Network Controller sdnc<../submodules/sdnc/oam.git/docs/release-notes.rst> -Service Orchestration ---------------------- +Use Case User Interface +----------------------- .. toctree:: :maxdepth: 1 :titlesonly: - so<../submodules/so.git/docs/release-notes.rst> + usecase-ui<../submodules/usecase-ui.git/docs/release-notes.rst> Virtual Function Controller --------------------------- -- 2.16.6