Merge "Issue-ID: DOC-503 user guide about adding CloudSite amended to take into accou...

diff --git a/.gitmodules b/.gitmodules
index 7e89be0..afd2675 100644 (file)
--- a/.gitmodules
+++ b/.gitmodules
@@ -333,11 +333,6 @@
        url = ../aaf/sms
        branch = .
        ignore = dirty
-[submodule "docs/submodules/policy/apex-pdp.git"]
-       path = docs/submodules/policy/apex-pdp.git
-       url = ../policy/apex-pdp
-       branch = .
-       ignore = dirty
 [submodule "docs/submodules/multicloud/azure.git"]
        path = docs/submodules/multicloud/azure.git
        url = ../multicloud/azure
@@ -353,11 +348,6 @@
        url = ../optf/cmso
        branch = .
        ignore = dirty
-[submodule "docs/submodules/policy/distribution.git"]
-       path = docs/submodules/policy/distribution.git
-       url = ../policy/distribution
-       branch = .
-       ignore = dirty
 [submodule "docs/submodules/logging-analytics/pomba/pomba-audit-common.git"]
        path = docs/submodules/logging-analytics/pomba/pomba-audit-common.git
        url = ../logging-analytics/pomba/pomba-audit-common

diff --git a/docs/guides/onap-developer/developing/index.rst b/docs/guides/onap-developer/developing/index.rst
index b88790e..567f5b0 100644 (file)
--- a/docs/guides/onap-developer/developing/index.rst
+++ b/docs/guides/onap-developer/developing/index.rst
@@ -247,8 +247,6 @@ Policy Framework
 
    ../../../submodules/policy/parent.git/docs/index
    ../../../submodules/policy/engine.git/docs/index
-   ../../../submodules/policy/apex-pdp.git/docs/index
-   ../../../submodules/policy/distribution.git/docs/index
 
 Portal Platform
 ---------------

diff --git a/docs/guides/onap-developer/how-to-use-docs/include-documentation.rst b/docs/guides/onap-developer/how-to-use-docs/include-documentation.rst
index 6909cce..6f5b0d4 100644 (file)
--- a/docs/guides/onap-developer/how-to-use-docs/include-documentation.rst
+++ b/docs/guides/onap-developer/how-to-use-docs/include-documentation.rst
@@ -51,7 +51,10 @@ login to gerrit or for git clone requests over ssh.
 The next step is to add a directory in the doc project where your
 project will be included as a submodule and at least one reference
 from the doc project to the documentation index in your repository.
-The following sequence will do this over ssh.
+The following sequence will do this over ssh. Please note that the
+reference to your project in *repolist.rst* should be considered
+temporary and removed when you reference it from more appropriate
+place.
 
 .. caution::
 
@@ -427,17 +430,27 @@ One Project
 -----------
 To test how the documentation renders in HTML, follow these steps:
 
-Install virtual environment.
+Install `virtual environment <https://pypi.org/project/virtualenv>`_ & create one.
 
 .. code-block:: bash
 
    sudo pip install virtualenv
+   virtualenv onap_docs
+
+Activate `onap_docs` virtual environment.
+
+.. code-block:: bash
+
+   source onap_docs/bin/activate
+
+.. note:: Virtual environment activation has to be performed before attempting to build documentation.
+          Otherwise, tools necessary for the process might not be available.
 
 Download a project repository.
 
 .. code-block:: bash
 
-  git clone http://gerrit.onap.org/r/<project>
+   git clone http://gerrit.onap.org/r/<project>
 
 Download the doc repository.
 
@@ -450,7 +463,7 @@ Change directory to doc & install requirements.
 .. code-block:: bash
 
    cd doc
-   sudo pip install -r etc/requirements.txt
+   pip install -r etc/requirements.txt
 
 Copy the conf.py file to your project folder where RST files have been kept:
 
@@ -476,7 +489,7 @@ specified output folder directory.
 You can use your Web Browser to open
 and check resulting html pages in the output folder.
 
-.. note:: Be sure to remove the `conf.py`, the static/ files and the output folder from the `<project>/docs/`.This is for testing only. Only commit the rst files and related content.
+.. note:: Be sure to remove the `conf.py`, the static/ files and the output folder from the `<project>/docs/`. This is for testing only. Only commit the rst files and related content.
 
 .. _building-all-documentation:
 

diff --git a/docs/release/repolist.rst b/docs/release/repolist.rst
index e75abf1..9f59f00 100644 (file)
--- a/docs/release/repolist.rst
+++ b/docs/release/repolist.rst
@@ -78,7 +78,7 @@ Project/Components
    integration <../submodules/integration.git/docs/index>
    msb/discovery <../submodules/msb/discovery.git/docs/index>
    msb/java-sdk <../submodules/msb/java-sdk.git/docs/index>
-   policy/apex-pdp <../submodules/policy/apex-pdp.git/docs/index>
+   policy/parent <../submodules/policy/parent.git/docs/index>
    sdc/jtosca <../submodules/sdc/jtosca.git/docs/index>
    sdc/sdc-distribution-client <../submodules/sdc/sdc-distribution-client.git/docs/index>
    sdc/sdc-docker-base <../submodules/sdc/sdc-docker-base.git/docs/index>

diff --git a/docs/submodules/aai/sparky-be.git b/docs/submodules/aai/sparky-be.git
index d2a7058..da2fd73 160000 (submodule)
--- a/docs/submodules/aai/sparky-be.git
+++ b/docs/submodules/aai/sparky-be.git
@@ -1 +1 @@
-Subproject commit d2a7058c50537fdf3406a417218db5607b23eff8
+Subproject commit da2fd730ddb9a21965ac77829fd2bbd50c36c43c

diff --git a/docs/submodules/appc.git b/docs/submodules/appc.git
index d368feb..b1d55dd 160000 (submodule)
--- a/docs/submodules/appc.git
+++ b/docs/submodules/appc.git
@@ -1 +1 @@
-Subproject commit d368feb33cf3dcf1008b060503b7a41edef67e9e
+Subproject commit b1d55dd69c4a1b808b2a2ab995172e4bfdabfaea

diff --git a/docs/submodules/ccsdk/cds.git b/docs/submodules/ccsdk/cds.git
index e827a3a..7d58591 160000 (submodule)
--- a/docs/submodules/ccsdk/cds.git
+++ b/docs/submodules/ccsdk/cds.git
@@ -1 +1 @@
-Subproject commit e827a3aee231453f704fef1a945d13de380a83c5
+Subproject commit 7d58591a2dd41b9e2655f5d06a1eb344146d8e76

diff --git a/docs/submodules/ccsdk/distribution.git b/docs/submodules/ccsdk/distribution.git
index b5b8167..9f4fd31 160000 (submodule)
--- a/docs/submodules/ccsdk/distribution.git
+++ b/docs/submodules/ccsdk/distribution.git
@@ -1 +1 @@
-Subproject commit b5b816769e0fd6f3068c13eb004ad2ca95b9cd9b
+Subproject commit 9f4fd319d2f04b401f28ddd9790f3ea41754f9b6

diff --git a/docs/submodules/ccsdk/features.git b/docs/submodules/ccsdk/features.git
index 7bbcdbb..104f65e 160000 (submodule)
--- a/docs/submodules/ccsdk/features.git
+++ b/docs/submodules/ccsdk/features.git
@@ -1 +1 @@
-Subproject commit 7bbcdbb841d81217e6a341a6eeaa8c6fda8daf46
+Subproject commit 104f65e0fd4cb9c6b411e77f7c81e3d82c896803

diff --git a/docs/submodules/ccsdk/parent.git b/docs/submodules/ccsdk/parent.git
index 322f4ff..6073799 160000 (submodule)
--- a/docs/submodules/ccsdk/parent.git
+++ b/docs/submodules/ccsdk/parent.git
@@ -1 +1 @@
-Subproject commit 322f4ffd1216bd01bde2b0f0f4c310811df1c129
+Subproject commit 6073799f2b75c716b44e818f7c3a8b914deea47e

diff --git a/docs/submodules/ccsdk/platform/plugins.git b/docs/submodules/ccsdk/platform/plugins.git
index 6b5636f..d7275e7 160000 (submodule)
--- a/docs/submodules/ccsdk/platform/plugins.git
+++ b/docs/submodules/ccsdk/platform/plugins.git
@@ -1 +1 @@
-Subproject commit 6b5636fe2ddaab95d180876127701e71639faf78
+Subproject commit d7275e776cbfa0484d82700bdabf47da91b46114

diff --git a/docs/submodules/clamp.git b/docs/submodules/clamp.git
index 7c7323d..e44fdb1 160000 (submodule)
--- a/docs/submodules/clamp.git
+++ b/docs/submodules/clamp.git
@@ -1 +1 @@
-Subproject commit 7c7323d8ec54e65ac7a9a5e8c7cd8bdc755ea70a
+Subproject commit e44fdb1905fae612b12b56886af8f387e516e485

diff --git a/docs/submodules/dmaap/datarouter.git b/docs/submodules/dmaap/datarouter.git
index cec9a92..98572b7 160000 (submodule)
--- a/docs/submodules/dmaap/datarouter.git
+++ b/docs/submodules/dmaap/datarouter.git
@@ -1 +1 @@
-Subproject commit cec9a9227c805ff5415d6b9fd913fa64adafdd3a
+Subproject commit 98572b78fcce9ff28fa7429c9265812bd1e78bf2

diff --git a/docs/submodules/integration.git b/docs/submodules/integration.git
index 3adfd35..e781c7c 160000 (submodule)
--- a/docs/submodules/integration.git
+++ b/docs/submodules/integration.git
@@ -1 +1 @@
-Subproject commit 3adfd35f7946e0ff31870fe69ab7f43d127303b2
+Subproject commit e781c7c4e4e385f504254d0fd32f534d559af3c2

diff --git a/docs/submodules/logging-analytics.git b/docs/submodules/logging-analytics.git
index 8699c66..58389c5 160000 (submodule)
--- a/docs/submodules/logging-analytics.git
+++ b/docs/submodules/logging-analytics.git
@@ -1 +1 @@
-Subproject commit 8699c6606de31c116cd45f2fc74f048a5e3f397c
+Subproject commit 58389c5f0afee416211e1fcb02c456c5ba10aeec

diff --git a/docs/submodules/msb/apigateway.git b/docs/submodules/msb/apigateway.git
index 18352a4..faabc5c 160000 (submodule)
--- a/docs/submodules/msb/apigateway.git
+++ b/docs/submodules/msb/apigateway.git
@@ -1 +1 @@
-Subproject commit 18352a47ee8f6e4fbb499dc1eee20587b1e53439
+Subproject commit faabc5c70fd285d3698d45516841f99459a89bea

diff --git a/docs/submodules/multicloud/azure.git b/docs/submodules/multicloud/azure.git
index 8ab92db..8336964 160000 (submodule)
--- a/docs/submodules/multicloud/azure.git
+++ b/docs/submodules/multicloud/azure.git
@@ -1 +1 @@
-Subproject commit 8ab92dba524aacc4956497d72f6aa1b25ceb1adc
+Subproject commit 833696479f69255cd58eb5cfe7b729e15a640fef

diff --git a/docs/submodules/multicloud/framework.git b/docs/submodules/multicloud/framework.git
index 96bb41e..c5bacb8 160000 (submodule)
--- a/docs/submodules/multicloud/framework.git
+++ b/docs/submodules/multicloud/framework.git
@@ -1 +1 @@
-Subproject commit 96bb41e64271accc719a49736bb9a2c89c49f25b
+Subproject commit c5bacb8c02da8ef280359b0c492468403f89fda3

diff --git a/docs/submodules/multicloud/k8s.git b/docs/submodules/multicloud/k8s.git
index 8445148..7ff9966 160000 (submodule)
--- a/docs/submodules/multicloud/k8s.git
+++ b/docs/submodules/multicloud/k8s.git
@@ -1 +1 @@
-Subproject commit 8445148cf095fcc55a9ada3e2bb0fece7a065089
+Subproject commit 7ff99668b98aae1210f72e84fcc1305814563600

diff --git a/docs/submodules/oom.git b/docs/submodules/oom.git
index 1b98488..887a978 160000 (submodule)
--- a/docs/submodules/oom.git
+++ b/docs/submodules/oom.git
@@ -1 +1 @@
-Subproject commit 1b9848822827bcf68f5573ab2b664b8c73ef0f7b
+Subproject commit 887a978cd68c4cf826b5b2f535e43c0eef11dbee

diff --git a/docs/submodules/optf/cmso.git b/docs/submodules/optf/cmso.git
index e8aaf9e..8d79b30 160000 (submodule)
--- a/docs/submodules/optf/cmso.git
+++ b/docs/submodules/optf/cmso.git
@@ -1 +1 @@
-Subproject commit e8aaf9e7a6dbe61f1508c6b7f04fa9b14f2e4c7d
+Subproject commit 8d79b30fed898ede2b551a579e3564cb196f707b

diff --git a/docs/submodules/policy/apex-pdp.git b/docs/submodules/policy/apex-pdp.git
deleted file mode 160000 (submodule)
index 5c384fb..0000000
--- a/docs/submodules/policy/apex-pdp.git
+++ /dev/null
@@ -1 +0,0 @@
-Subproject commit 5c384fb2888029c2babb859c30318749e1ce828c

diff --git a/docs/submodules/policy/distribution.git b/docs/submodules/policy/distribution.git
deleted file mode 160000 (submodule)
index d1e0acb..0000000
--- a/docs/submodules/policy/distribution.git
+++ /dev/null
@@ -1 +0,0 @@
-Subproject commit d1e0acb7a85403e365764589327b9aef62509318

diff --git a/docs/submodules/policy/parent.git b/docs/submodules/policy/parent.git
index 0c56e11..7fd4a6e 160000 (submodule)
--- a/docs/submodules/policy/parent.git
+++ b/docs/submodules/policy/parent.git
@@ -1 +1 @@
-Subproject commit 0c56e114555b17818d2ee03bb680f27df8158ade
+Subproject commit 7fd4a6ee280b40916d5438b4bd4e2c5a8e043f13

diff --git a/docs/submodules/portal.git b/docs/submodules/portal.git
index f26978c..7324846 160000 (submodule)
--- a/docs/submodules/portal.git
+++ b/docs/submodules/portal.git
@@ -1 +1 @@
-Subproject commit f26978caa8e8aa870c47032a2adb5284a71a72bb
+Subproject commit 73248465fc2867a3dd1a6494afb6b0774c9028f2

diff --git a/docs/submodules/sdc.git b/docs/submodules/sdc.git
index 57844f3..c8fcbbc 160000 (submodule)
--- a/docs/submodules/sdc.git
+++ b/docs/submodules/sdc.git
@@ -1 +1 @@
-Subproject commit 57844f30fc90a9b5007180c2da7a06977942d4fe
+Subproject commit c8fcbbc2a9cc964ba1d4b872562b8f4185047308

diff --git a/docs/submodules/sdc/jtosca.git b/docs/submodules/sdc/jtosca.git
index 6018fb0..787ef0b 160000 (submodule)
--- a/docs/submodules/sdc/jtosca.git
+++ b/docs/submodules/sdc/jtosca.git
@@ -1 +1 @@
-Subproject commit 6018fb047963d151d77bf03f6f84446866a30899
+Subproject commit 787ef0b09708ba160efa81e507fd8d0bc6719f43

diff --git a/docs/submodules/sdc/sdc-distribution-client.git b/docs/submodules/sdc/sdc-distribution-client.git
index eb47236..19c8bdc 160000 (submodule)
--- a/docs/submodules/sdc/sdc-distribution-client.git
+++ b/docs/submodules/sdc/sdc-distribution-client.git
@@ -1 +1 @@
-Subproject commit eb47236253465eaf1ad92313f799f4e399c24914
+Subproject commit 19c8bdce471587972861d395149564950f0d4a45

diff --git a/docs/submodules/sdc/sdc-tosca.git b/docs/submodules/sdc/sdc-tosca.git
index d814792..0414d98 160000 (submodule)
--- a/docs/submodules/sdc/sdc-tosca.git
+++ b/docs/submodules/sdc/sdc-tosca.git
@@ -1 +1 @@
-Subproject commit d8147920f168eddb65722543054cafe06f5bf201
+Subproject commit 0414d985162bad8bad29a1e0527b84a3ff6c0aa3

diff --git a/docs/submodules/so.git b/docs/submodules/so.git
index 781ae82..4f7af8b 160000 (submodule)
--- a/docs/submodules/so.git
+++ b/docs/submodules/so.git
@@ -1 +1 @@
-Subproject commit 781ae827294edc8e9a25d1ac83d7399be8186e8b
+Subproject commit 4f7af8bab030fc3d331816a706dd0a9e2974c455

diff --git a/docs/submodules/vfc/nfvo/lcm.git b/docs/submodules/vfc/nfvo/lcm.git
index b0a0596..1757a7e 160000 (submodule)
--- a/docs/submodules/vfc/nfvo/lcm.git
+++ b/docs/submodules/vfc/nfvo/lcm.git
@@ -1 +1 @@
-Subproject commit b0a05961ea9bc959a675615d19c0f234b161c679
+Subproject commit 1757a7e0f63f892200d680bb228db19ec993d1a2

diff --git a/docs/submodules/vid.git b/docs/submodules/vid.git
index 58d22b5..7befef8 160000 (submodule)
--- a/docs/submodules/vid.git
+++ b/docs/submodules/vid.git
@@ -1 +1 @@
-Subproject commit 58d22b526418ffeb89337fed9e20406da420bc6f
+Subproject commit 7befef8d013fb9e5627a50f7fb1e1937eb27e483