Code Review / doc.git / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | review | tree
raw | inline | side by side
Move cert-service documentation from aaf to oom/platform
[doc.git] / docs / guides / onap-developer / developing / index.rst
diff --git a/docs/guides/onap-developer/developing/index.rst b/docs/guides/onap-developer/developing/index.rst
index a7087e3..2afddb7 100644 (file)
--- a/docs/guides/onap-developer/developing/index.rst
+++ b/docs/guides/onap-developer/developing/index.rst
@@ -18,11 +18,11 @@ Active and Available Inventory
    :maxdepth: 2
    :titlesonly:
 
-   ../../../submodules/aai/aai-common.git/docs/index
-   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
+| :ref:`aai aai-common<onap-aai-aai-common:master_index>`
+| :ref:`AAI-esr-gui<onap-aai-esr-gui:master_index>`
+| :ref:`aai esr-server<onap-aai-esr-server:master_index>`
+| :ref:`aai sparky-be<onap-aai-sparky-be:master_index>`
+| :ref:`aai event-clientrst<onap-aai-event-client:master_index>`
 
 
 Application Controller
@@ -32,8 +32,8 @@ Application Controller
    :maxdepth: 2
    :titlesonly:
 
-   ../../../submodules/appc/deployment.git/docs/index
-   ../../../submodules/appc.git/docs/index
+| :ref:`appc deployment<onap-appc-deployment:master_index>`
+| :ref:`appc<onap-appc:master_index>`
 
 Application Authorization Framework
 -----------------------------------
@@ -42,8 +42,8 @@ Application Authorization Framework
    :maxdepth: 2
    :titlesonly:
 
-   ../../../submodules/aaf/authz.git/docs/index
-   Secret Management Service <../../../submodules/aaf/sms.git/docs/index>
+| :ref:`aaf authz<onap-aaf-authz:master_index>`
+| :ref:`Secret Management Service<onap-aaf-sms:master_index>`
 
 Command Line Interface
 ----------------------
@@ -52,17 +52,17 @@ Command Line Interface
    :maxdepth: 2
    :titlesonly:
 
-   ../../../submodules/cli.git/docs/index
+:ref:`cli<onap-cli:master_index>`
 
 
-Closed Loop Automation Platform
--------------------------------
+Control Loop Automation Management Platform
+-------------------------------------------
 
 .. toctree::
    :maxdepth: 2
    :titlesonly:
 
-   ../../../submodules/clamp.git/docs/index
+:ref:`clamp<onap-clamp:master_index>`
 
 Common Controller Software Development Kit
 ------------------------------------------
@@ -71,23 +71,11 @@ Common Controller Software Development Kit
    :maxdepth: 2
    :titlesonly:
 
-   ../../../submodules/ccsdk/distribution.git/docs/index
-   ../../../submodules/ccsdk/dashboard.git/docs/index
-   ../../../submodules/ccsdk/platform/plugins.git/docs/index
-   ../../../submodules/ccsdk/apps.git/docs/index
-   ../../../submodules/ccsdk/cds.git/docs/index
-
-.. Being consolidated in ccsdk distribution
-   ../../../submodules/ccsdk/platform/blueprints.git/docs/index
-   ../../../submodules/ccsdk/platform/nbapi.git/docs/index
-   ../../../submodules/ccsdk/storage/esaas.git/docs/index
-   ../../../submodules/ccsdk/storage/pgaas.git/docs/index
-   ../../../submodules/ccsdk/utils.git/docs/index
-   ../../../submodules/ccsdk/parent.git/docs/index
-   ../../../submodules/ccsdk/sli/adaptors.git/docs/index
-   ../../../submodules/ccsdk/sli/core.git/docs/index
-   ../../../submodules/ccsdk/sli/northbound.git/docs/index
-   ../../../submodules/ccsdk/sli/plugins.git/docs/index
+| :ref:`ccsdk distribution<onap-ccsdk-distribution:master_index>`
+| :ref:`ccsdk dashboard<onap-ccsdk-dashboard:master_index>`
+| :ref:`ccsdk platform plugins<onap-ccsdk-platform-plugins:master_index>`
+| :ref:`ccsdk apps<onap-ccsdk-apps:master_index>`
+| :ref:`ccsdk cds<onap-ccsdk-cds:master_index>`
 
 Data Collection, Analysis, and Events
 -------------------------------------
@@ -96,7 +84,7 @@ Data Collection, Analysis, and Events
    :maxdepth: 2
    :titlesonly:
 
-   ../../../submodules/dcaegen2.git/docs/index
+:ref:`dcaegen2<onap-dcaegen2:master_index>`
 
 Data Management as a Platform Data Bus Controller
 -------------------------------------------------
@@ -105,8 +93,8 @@ Data Management as a Platform Data Bus Controller
    :maxdepth: 1
    :titlesonly:
 
-   ../../../submodules/dmaap/dbcapi.git/docs/index
-   ../../../submodules/dmaap/buscontroller.git/docs/index
+| :ref:`dmaap dbcapi<onap-dmaap-dbcapi:master_index>`
+| :ref:`dmaap buscontroller<onap-dmaap-buscontroller:master_index>`
 
 Data Management as a Platform Data Router
 -----------------------------------------
@@ -115,7 +103,7 @@ Data Management as a Platform Data Router
    :maxdepth: 1
    :titlesonly:
 
-   ../../../submodules/dmaap/datarouter.git/docs/index
+:ref:`dmaap datarouter<onap-dmaap-datarouter:master_index>`
 
 Data Management as a Platform Message Router
 --------------------------------------------
@@ -124,17 +112,7 @@ Data Management as a Platform Message Router
    :maxdepth: 2
    :titlesonly:
 
-   ../../../submodules/dmaap/messagerouter/messageservice.git/docs/index
-
-Development Tools
------------------
-
-.. toctree::
-   :maxdepth: 1
-   :titlesonly:
-
-   ../../../submodules/integration/devtool.git/docs/source/index
-
+:ref:`dmaap messagerouter messageservice<onap-dmaap-messagerouter-messageservice:master_index>`
 
 External API Framework
 ----------------------
@@ -143,7 +121,7 @@ External API Framework
    :maxdepth: 2
    :titlesonly:
 
-   ../../../submodules/externalapi/nbi.git/docs/index
+:ref:`externalapi nbi<onap-externalapi-nbi:master_index>`
 
 
 Holmes
@@ -153,8 +131,8 @@ Holmes
    :maxdepth: 2
    :titlesonly:
 
-   Alarm Correlation and Analysis <../../../submodules/holmes/engine-management.git/docs/index>
-   Architecture and APIs <../../../submodules/holmes/rule-management.git/docs/index>
+| :ref:`Alarm Correlation and Analysis<onap-holmes-engine-management:master_index>`
+| :ref:`Architecture and APIs<onap-holmes-rule-management:master_index>`
 
 Integration
 -----------
@@ -163,7 +141,7 @@ Integration
    :maxdepth: 1
    :titlesonly:
 
-   ../../../submodules/integration.git/docs/index
+:ref:`integration<onap-integration:master_index>`
 
 Logging Analytics
 -----------------
@@ -172,7 +150,7 @@ Logging Analytics
    :maxdepth: 2
    :titlesonly:
 
-   ../../../submodules/logging-analytics.git/docs/index
+:ref:`logging-analytics<onap-logging-analytics:master_index>`
 
 Micro Services Bus
 ------------------
@@ -181,12 +159,9 @@ Micro Services Bus
    :maxdepth: 2
    :titlesonly:
 
-   ../../../submodules/msb/apigateway.git/docs/index
-   ../../../submodules/msb/swagger-sdk.git/docs/index
+:ref:`msb apigateway<onap-msb-apigateway:master_index>`
 
-.. Empty folders in this release
-   ../../../submodules/msb/discovery.git/docs/index
-   ../../../submodules/msb/java-sdk.git/docs/index
+:ref:`msb swagger-sdk<onap-msb-swagger-sdk:master_index>`
 
 
 Modeling
@@ -196,8 +171,9 @@ Modeling
    :maxdepth: 2
    :titlesonly:
 
-   ../../../submodules/modeling/modelspec.git/docs/index
-   ../../../submodules/modeling/toscaparsers.git/docs/index
+:ref:`modeling modelspec<onap-modeling-modelspec:master_index>`
+
+:ref:`modeling etsicatalog<onap-modeling-etsicatalog:master_index>`
 
 MultiVIM Cloud
 --------------
@@ -206,7 +182,7 @@ MultiVIM Cloud
    :maxdepth: 2
    :titlesonly:
 
-   ../../../submodules/multicloud/framework.git/docs/index
+:ref:`multicloud framework<onap-multicloud-framework:master_index>`
 
 Music
 -----
@@ -215,8 +191,9 @@ Music
    :maxdepth: 2
    :titlesonly:
 
-   ../../../submodules/music.git/docs/index
-   ../../../submodules/music/distributed-kv-store.git/docs/index
+:ref:`music<onap-music:master_index>`
+
+:ref:`music distributed-kv-store<onap-music-distributed-kv-store:master_index>`
 
 ONAP Operations Manager
 -----------------------
@@ -225,7 +202,8 @@ ONAP Operations Manager
    :maxdepth: 2
    :titlesonly:
 
-   ../../../submodules/oom.git/docs/index
+| :ref:`oom<onap-oom:master_index>`
+| :ref:`oom/platform/cert-service<onap-oom-certservice:master_index>`
 
 Optimization Framework
 ----------------------
@@ -234,9 +212,9 @@ Optimization Framework
    :maxdepth: 2
    :titlesonly:
 
-   ../../../submodules/optf/has.git/docs/index
-   ../../../submodules/optf/osdf.git/docs/index
-   ../../../submodules/optf/cmso.git/docs/index
+| :ref:`optf has<onap-optf-has:master_index>`
+| :ref:`optf osdf<onap-optf-osdf:master_index>`
+| :ref:`optf cmso<onap-optf-cmso:master_index>`
 
 Policy Framework
 ----------------
@@ -245,8 +223,9 @@ Policy Framework
    :maxdepth: 2
    :titlesonly:
 
-   ../../../submodules/policy/parent.git/docs/index
-   ../../../submodules/policy/engine.git/docs/index
+:ref:`policy parent<onap-policy-parent:master_index>`
+
+:ref:`policy engine<onap-policy-engine:master_index>`
 
 Portal Platform
 ---------------
@@ -255,7 +234,7 @@ Portal Platform
    :maxdepth: 2
    :titlesonly:
 
-   ../../../submodules/portal.git/docs/index
+:ref:`portal<onap-portal:master_index>`
 
 Service Design & Creation
 -------------------------
@@ -264,15 +243,7 @@ Service Design & Creation
    :maxdepth: 2
    :titlesonly:
 
-   ../../../submodules/sdc.git/docs/index
-
-.. Empty folders for this release
-   ../../../submodules/sdc/jtosca.git/docs/index
-   ../../../submodules/sdc/sdc-distribution-client.git/docs/index
-   ../../../submodules/sdc/sdc-docker-base.git/docs/index
-   ../../../submodules/sdc/sdc-titan-cassandra.git/docs/index
-   ../../../submodules/sdc/sdc-tosca.git/docs/index
-   ../../../submodules/sdc/sdc-workflow-designer.git/docs/index
+:ref:`sdc<onap-sdc:master_index>`
 
 Service Orchestration
 ---------------------
@@ -281,8 +252,9 @@ Service Orchestration
    :maxdepth: 2
    :titlesonly:
 
-   ../../../submodules/so.git/docs/index
-   ../../../submodules/so/libs.git/docs/index
+:ref:`so<onap-so:master_index>`
+
+:ref:`so libs<onap-so-libs:master_index>`
 
 Software Defined Network Controller
 -----------------------------------
@@ -291,16 +263,7 @@ Software Defined Network Controller
    :maxdepth: 2
    :titlesonly:
 
-   ../../../submodules/sdnc/oam.git/docs/index
-
-.. Empty folders for this release
-   ../../../submodules/sdnc/adaptors.git/docs/index
-   ../../../submodules/sdnc/architecture.git/docs/index
-   ../../../submodules/sdnc/core.git/docs/index
-   ../../../submodules/sdnc/features.git/docs/index
-   ../../../submodules/sdnc/northbound.git/docs/index
-   ../../../submodules/sdnc/parent.git/docs/index
-   ../../../submodules/sdnc/plugins.git/docs/index
+:ref:`sdnc oam<onap-sdnc-oam:master_index>`
 
 Software Defined Network Controller for Radio (SDN-R)
 -----------------------------------------------------
@@ -309,7 +272,7 @@ Software Defined Network Controller for Radio (SDN-R)
    :maxdepth: 2
    :titlesonly:
 
-   ../../../submodules/ccsdk/features.git/docs/index
+:ref:`ccsdk features<onap-ccsdk-features:master_index>`
 
 Use Case User Interface
 -----------------------
@@ -318,16 +281,7 @@ Use Case User Interface
    :maxdepth: 2
    :titlesonly:
 
-   ../../../submodules/usecase-ui.git/docs/index
-
-User Interface Applications
----------------------------
-
-.. toctree::
-   :maxdepth: 2
-   :titlesonly:
-
-   ../../../submodules/ui/dmaapbc.git/docs/index
+:ref:`usecase-ui<onap-usecase-ui:master_index>`
 
 Virtual Function Controller
 ---------------------------
@@ -336,7 +290,7 @@ Virtual Function Controller
    :maxdepth: 2
    :titlesonly:
 
-   ../../../submodules/vfc/nfvo/lcm.git/docs/index
+:ref:`vfc nfvo lcm<onap-vfc-nfvo-lcm:master_index>`
 
 Virtual Infrastructure Deployment
 ---------------------------------
@@ -346,10 +300,7 @@ Virtual Infrastructure Deployment
    :titlesonly:
 
 
-   ../../../submodules/vid.git/docs/index
-
-.. Empty folders for this release
-   ../../../submodules/vid/asdcclient.git/docs/index
+:ref:`vid<onap-vid:master_index>`
 
 VNF Software Development Kit
 ----------------------------
@@ -358,4 +309,4 @@ VNF Software Development Kit
    :maxdepth: 2
    :titlesonly:
 
-   ../../../submodules/vnfsdk/model.git/docs/index
+:ref:`vnfsdk model<onap-vnfsdk-model:master_index>`
Create and maintain documentation targeted to ONAP user audiences