X-Git-Url: https://gerrit.onap.org/r/gitweb?a=blobdiff_plain;f=docs%2Fguides%2Fonap-developer%2Fdeveloping%2Findex.rst;h=2afddb76429d92cee48451951a2f999c2ffe93ab;hb=1a16ca9a7e3a3dd948f741ff3d7ed4e800bfb6e5;hp=d481933dce7234ba9a10613e912f271e848bc3bc;hpb=2c6212df89d4b81bf638a928319375d8214ab651;p=doc.git diff --git a/docs/guides/onap-developer/developing/index.rst b/docs/guides/onap-developer/developing/index.rst index d481933dc..2afddb764 100644 --- a/docs/guides/onap-developer/developing/index.rst +++ b/docs/guides/onap-developer/developing/index.rst @@ -7,8 +7,8 @@ .. _doc_onap-developer_guide_projects: -Developing ONAP -=============== +ONAP components and functionalities +=================================== Additional developer level detail is provided for each project below. Active and Available Inventory @@ -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` +| :ref:`AAI-esr-gui` +| :ref:`aai esr-server` +| :ref:`aai sparky-be` +| :ref:`aai event-clientrst` 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` +| :ref:`appc` 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` +| :ref:`Secret Management Service` Command Line Interface ---------------------- @@ -52,17 +52,17 @@ Command Line Interface :maxdepth: 2 :titlesonly: - ../../../submodules/cli.git/docs/index +:ref:`cli` -Closed Loop Automation Platform -------------------------------- +Control Loop Automation Management Platform +------------------------------------------- .. toctree:: :maxdepth: 2 :titlesonly: - ../../../submodules/clamp.git/docs/index +:ref:`clamp` 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` +| :ref:`ccsdk dashboard` +| :ref:`ccsdk platform plugins` +| :ref:`ccsdk apps` +| :ref:`ccsdk cds` Data Collection, Analysis, and Events ------------------------------------- @@ -96,7 +84,7 @@ Data Collection, Analysis, and Events :maxdepth: 2 :titlesonly: - ../../../submodules/dcaegen2.git/docs/index +:ref:`dcaegen2` 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` +| :ref:`dmaap buscontroller` 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` Data Management as a Platform Message Router -------------------------------------------- @@ -124,26 +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 - -Documentation -------------- - -.. toctree:: - :maxdepth: 2 - :titlesonly: - - ../how-to-use-docs/index.rst - +:ref:`dmaap messagerouter messageservice` External API Framework ---------------------- @@ -152,7 +121,7 @@ External API Framework :maxdepth: 2 :titlesonly: - ../../../submodules/externalapi/nbi.git/docs/index +:ref:`externalapi nbi` Holmes @@ -162,18 +131,17 @@ 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` +| :ref:`Architecture and APIs` Integration ----------- -* ONAP Casablanca release content is specified within a list of project - artifact versions available in the form of - a :ref:`manifest`. +.. toctree:: + :maxdepth: 1 + :titlesonly: -* To install the whole ONAP (from a complete demo solution perspective) - refer to :ref:`Setting Up ONAP `. +:ref:`integration` Logging Analytics ----------------- @@ -182,7 +150,7 @@ Logging Analytics :maxdepth: 2 :titlesonly: - ../../../submodules/logging-analytics.git/docs/index +:ref:`logging-analytics` Micro Services Bus ------------------ @@ -191,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` -.. Empty folders in this release - ../../../submodules/msb/discovery.git/docs/index - ../../../submodules/msb/java-sdk.git/docs/index +:ref:`msb swagger-sdk` Modeling @@ -206,8 +171,9 @@ Modeling :maxdepth: 2 :titlesonly: - ../../../submodules/modeling/modelspec.git/docs/index - ../../../submodules/modeling/toscaparsers.git/docs/index +:ref:`modeling modelspec` + +:ref:`modeling etsicatalog` MultiVIM Cloud -------------- @@ -216,7 +182,7 @@ MultiVIM Cloud :maxdepth: 2 :titlesonly: - ../../../submodules/multicloud/framework.git/docs/index +:ref:`multicloud framework` Music ----- @@ -225,8 +191,9 @@ Music :maxdepth: 2 :titlesonly: - ../../../submodules/music.git/docs/index - ../../../submodules/music/distributed-kv-store.git/docs/index +:ref:`music` + +:ref:`music distributed-kv-store` ONAP Operations Manager ----------------------- @@ -235,7 +202,8 @@ ONAP Operations Manager :maxdepth: 2 :titlesonly: - ../../../submodules/oom.git/docs/index +| :ref:`oom` +| :ref:`oom/platform/cert-service` Optimization Framework ---------------------- @@ -244,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` +| :ref:`optf osdf` +| :ref:`optf cmso` Policy Framework ---------------- @@ -255,9 +223,9 @@ Policy Framework :maxdepth: 2 :titlesonly: - ../../../submodules/policy/engine.git/docs/index - ../../../submodules/policy/apex-pdp.git/docs/index - ../../../submodules/policy/distribution.git/docs/index +:ref:`policy parent` + +:ref:`policy engine` Portal Platform --------------- @@ -266,7 +234,7 @@ Portal Platform :maxdepth: 2 :titlesonly: - ../../../submodules/portal.git/docs/index +:ref:`portal` Service Design & Creation ------------------------- @@ -275,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` Service Orchestration --------------------- @@ -292,8 +252,9 @@ Service Orchestration :maxdepth: 2 :titlesonly: - ../../../submodules/so.git/docs/index - ../../../submodules/so/libs.git/docs/index +:ref:`so` + +:ref:`so libs` Software Defined Network Controller ----------------------------------- @@ -302,34 +263,25 @@ Software Defined Network Controller :maxdepth: 2 :titlesonly: - ../../../submodules/sdnc/oam.git/docs/index +:ref:`sdnc oam` -.. 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 - -Use Case User Interface ------------------------ +Software Defined Network Controller for Radio (SDN-R) +----------------------------------------------------- .. toctree:: :maxdepth: 2 :titlesonly: - ../../../submodules/usecase-ui.git/docs/index +:ref:`ccsdk features` -User Interface Applications ---------------------------- +Use Case User Interface +----------------------- .. toctree:: :maxdepth: 2 :titlesonly: - ../../../submodules/ui/dmaapbc.git/docs/index +:ref:`usecase-ui` Virtual Function Controller --------------------------- @@ -338,7 +290,7 @@ Virtual Function Controller :maxdepth: 2 :titlesonly: - ../../../submodules/vfc/nfvo/lcm.git/docs/index +:ref:`vfc nfvo lcm` Virtual Infrastructure Deployment --------------------------------- @@ -348,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` VNF Software Development Kit ---------------------------- @@ -360,4 +309,4 @@ VNF Software Development Kit :maxdepth: 2 :titlesonly: - ../../../submodules/vnfsdk/model.git/docs/index +:ref:`vnfsdk model`