From 36a8838f0c3c15bdc784fb1544afdbbe6bafc48a Mon Sep 17 00:00:00 2001 From: Rich Bennett Date: Tue, 2 Oct 2018 15:58:37 -0400 Subject: [PATCH] Eliminate duplicate toctree references Integrate recently added repos with doc project sections Remove references from releases/repolist.rst Remove vnfreq and vvp from developing section Change-Id: I22ed97db8740ddb4080340afbad00f0485858f22 Issue-ID: DOC-312 Signed-off-by: Rich Bennett --- .gitmodules | 2 + docs/guides/onap-developer/developing/index.rst | 52 +++++++++++++---------- docs/release/repolist.rst | 56 ++++++++++++++----------- 3 files changed, 64 insertions(+), 46 deletions(-) diff --git a/.gitmodules b/.gitmodules index c0e4198a0..9358b36ff 100644 --- a/.gitmodules +++ b/.gitmodules @@ -336,3 +336,5 @@ [submodule "docs/submodules/policy/apex-pdp.git"] path = docs/submodules/policy/apex-pdp.git url = ../policy/apex-pdp + branch = . + ignore = dirty diff --git a/docs/guides/onap-developer/developing/index.rst b/docs/guides/onap-developer/developing/index.rst index 41e3c70c1..0978edce7 100644 --- a/docs/guides/onap-developer/developing/index.rst +++ b/docs/guides/onap-developer/developing/index.rst @@ -22,6 +22,7 @@ Active and Available Inventory AAI-esr-gui <../../../submodules/aai/esr-gui.git/docs/index> ../../../submodules/aai/esr-server.git/docs/index ../../../submodules/aai/sparky-be.git/docs/index + ../../../submodules/aai/event-client.git/docs/index.rst Application Controller @@ -42,6 +43,7 @@ Application Authorization Framework :titlesonly: ../../../submodules/aaf/authz.git/docs/index + Secret Management Service <../../../submodules/aaf/sms.git/docs/index> Command Line Interface ---------------------- @@ -71,6 +73,7 @@ Common Controller Software Development Kit ../../../submodules/ccsdk/distribution.git/docs/index ../../../submodules/ccsdk/dashboard.git/docs/index + ../../../submodules/ccsdk/platform/plugins.git/docs/index .. Being consolidated in ccsdk distribution ../../../submodules/ccsdk/platform/blueprints.git/docs/index @@ -79,7 +82,6 @@ Common Controller Software Development Kit ../../../submodules/ccsdk/storage/pgaas.git/docs/index ../../../submodules/ccsdk/utils.git/docs/index ../../../submodules/ccsdk/parent.git/docs/index - ../../../submodules/ccsdk/platform/plugins.git/docs/index ../../../submodules/ccsdk/sli/adaptors.git/docs/index ../../../submodules/ccsdk/sli/core.git/docs/index ../../../submodules/ccsdk/sli/northbound.git/docs/index @@ -94,6 +96,24 @@ Data Collection, Analysis, and Events ../../../submodules/dcaegen2.git/docs/index +Data Management as a Platform Data Bus Controller +------------------------------------------------- + +.. toctree:: + :maxdepth: 1 + :titlesonly: + + ../../../submodules/dmaap/dbcapi.git/docs/index + +Data Management as a Platform Data Router +----------------------------------------- + +.. toctree:: + :maxdepth: 1 + :titlesonly: + + ../../../submodules/dmaap/datarouter.git/docs/index + Data Management as a Platform Message Router -------------------------------------------- @@ -103,6 +123,15 @@ Data Management as a Platform Message Router ../../../submodules/dmaap/messagerouter/messageservice.git/docs/index +Development Tools +----------------- + +.. toctree:: + :maxdepth: 1 + :titlesonly: + + ../../../submodules/integration/devtool.git/docs/source/index + Documentation ------------- @@ -194,6 +223,7 @@ Music :titlesonly: ../../../submodules/music.git/docs/index + ../../../submodules/music/distributed-kv-store.git/docs/index ONAP Operations Manager ----------------------- @@ -317,17 +347,6 @@ Virtual Infrastructure Deployment .. Empty folders for this release ../../../submodules/vid/asdcclient.git/docs/index -VNF Requirements ----------------- - -.. toctree:: - :maxdepth: 2 - :titlesonly: - - - ../../../submodules/vnfrqts/guidelines.git/docs/index - ../../../submodules/vnfrqts/requirements.git/docs/index - VNF Software Development Kit ---------------------------- @@ -336,12 +355,3 @@ VNF Software Development Kit :titlesonly: ../../../submodules/vnfsdk/model.git/docs/index - -VNF Validation Project ------------------------ - -.. toctree:: - :maxdepth: 2 - :titlesonly: - - ../../../submodules/vvp/documentation.git/docs/index diff --git a/docs/release/repolist.rst b/docs/release/repolist.rst index b91fe2b6d..5b87fa6be 100644 --- a/docs/release/repolist.rst +++ b/docs/release/repolist.rst @@ -9,46 +9,24 @@ Project/Components ------------------ - -.. toctree:: - :maxdepth: 1 - :titlesonly: - +.. Already referenced in other sections of doc project aaf/authz <../submodules/aaf/authz.git/docs/index> AAI - Active & Available Inventory <../submodules/aai/aai-common.git/docs/index> - aai/event-client <../submodules/aai/event-client.git/docs/index> AAI External System Registration Server <../submodules/aai/esr-server.git/docs/index> AAI External System Registration UI <../submodules/aai/esr-gui.git/docs/index> AAI Sparky Inventory UI <../submodules/aai/sparky-be.git/docs/index> CCSDK Dashboard <../submodules/ccsdk/dashboard.git/docs/index> ccsdk/distribution <../submodules/ccsdk/distribution.git/docs/index> - CCSDK Orchestrator Plugins <../submodules/ccsdk/platform/plugins.git/docs/index> - ccsdk/parent <../submodules/ccsdk/parent.git/docs/index> - ccsdk/platform/blueprints <../submodules/ccsdk/platform/blueprints.git/docs/index> - ccsdk/platform/nbapi <../submodules/ccsdk/platform/nbapi.git/docs/index> - ccsdk/storage/esaas <../submodules/ccsdk/storage/esaas.git/docs/index> - ccsdk/storage/pgaas <../submodules/ccsdk/storage/pgaas.git/docs/index> - ccsdk/utils <../submodules/ccsdk/utils.git/docs/index> - dmaap/datarouter <../submodules/dmaap/datarouter.git/docs/index> - dmaap/dbcapi <../submodules/dmaap/dbcapi.git/docs/index> HOLMES - Alarm Correlation and Analysis <../submodules/holmes/engine-management.git/docs/index> HOLMES - Architecuture and APIs <../submodules/holmes/rule-management.git/docs/index> - integration <../submodules/integration.git/docs/index> logging-analytics <../submodules/logging-analytics.git/docs/index> modeling/toscaparsers <../submodules/modeling/toscaparsers.git/docs/index> - msb/discovery <../submodules/msb/discovery.git/docs/index> - msb/java-sdk <../submodules/msb/java-sdk.git/docs/index> MSB - Microservice Bus <../submodules/msb/apigateway.git/docs/index> msb/swagger-sdk <../submodules/msb/swagger-sdk.git/docs/index> MultiCloud Framework <../submodules/multicloud/framework.git/docs/index> music <../submodules/music.git/docs/index> ONAP Operations Manager <../submodules/oom.git/docs/index> optf/osdf <../submodules/optf/osdf.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> - sdc/sdc-titan-cassandra <../submodules/sdc/sdc-titan-cassandra.git/docs/index> - sdc/sdc-tosca <../submodules/sdc/sdc-tosca.git/docs/index> sdc/sdc-workflow-designer <../submodules/sdc/sdc-workflow-designer.git/docs/index> sdnc/oam <../submodules/sdnc/oam.git/docs/index> Service Design and Creation <../submodules/sdc.git/docs/index> @@ -68,14 +46,42 @@ Project/Components ../submodules/vnfrqts/requirements.git/docs/index Use Case User Interface <../submodules/usecase-ui.git/docs/index> VFC - Virtual Function Controller <../submodules/vfc/nfvo/lcm.git/docs/index> - vid/asdcclient <../submodules/vid/asdcclient.git/docs/index> VID - Virtual Infrastructure Deployment <../submodules/vid.git/docs/index> VNF Software Development Kit <../submodules/vnfsdk/model.git/docs/index> vvp/documentation <../submodules/vvp/documentation.git/docs/index> externalapi/nbi <../submodules/externalapi/nbi.git/docs/index> - music/distributed-kv-store <../submodules/music/distributed-kv-store.git/docs/index> vnfrqts/testcases <../submodules/vnfrqts/testcases.git/docs/index> vnfrqts/usecases <../submodules/vnfrqts/usecases.git/docs/index> + aai/event-client <../submodules/aai/event-client.git/docs/index> + CCSDK Orchestrator Plugins <../submodules/ccsdk/platform/plugins.git/docs/index> Devtool <../submodules/integration/devtool.git/docs/source/index> Secret Management Service <../submodules/aaf/sms.git/docs/index> + dmaap/datarouter <../submodules/dmaap/datarouter.git/docs/index> + dmaap/dbcapi <../submodules/dmaap/dbcapi.git/docs/index> + music/distributed-kv-store <../submodules/music/distributed-kv-store.git/docs/index> + +.. The following submodules have been added but no content or in some cases + deprecated content appears. To eliminate toctree warnings until content + is updated or the submodule is removed we leave the references + +.. toctree:: + :maxdepth: 1 + :titlesonly: + + ccsdk/parent <../submodules/ccsdk/parent.git/docs/index> + ccsdk/platform/blueprints <../submodules/ccsdk/platform/blueprints.git/docs/index> + ccsdk/platform/nbapi <../submodules/ccsdk/platform/nbapi.git/docs/index> + ccsdk/storage/esaas <../submodules/ccsdk/storage/esaas.git/docs/index> + ccsdk/storage/pgaas <../submodules/ccsdk/storage/pgaas.git/docs/index> + ccsdk/utils <../submodules/ccsdk/utils.git/docs/index> + 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> + 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> + sdc/sdc-titan-cassandra <../submodules/sdc/sdc-titan-cassandra.git/docs/index> + sdc/sdc-tosca <../submodules/sdc/sdc-tosca.git/docs/index> + vid/asdcclient <../submodules/vid/asdcclient.git/docs/index> + -- 2.16.6