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=b92541769975e3d2ebf1d582b581b6f9f9b8718a;hpb=3c554ce03a69fe36138dfca8a1cdba4b2f9dbc31;p=doc.git diff --git a/docs/guides/onap-developer/developing/index.rst b/docs/guides/onap-developer/developing/index.rst index b92541769..2afddb764 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. @@ -6,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 @@ -17,10 +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 +| :ref:`aai aai-common` +| :ref:`AAI-esr-gui` +| :ref:`aai esr-server` +| :ref:`aai sparky-be` +| :ref:`aai event-clientrst` Application Controller @@ -30,17 +32,37 @@ Application Controller :maxdepth: 2 :titlesonly: - ../../../submodules/appc/deployment.git/docs/index - ../../../submodules/appc.git/docs/index +| :ref:`appc deployment` +| :ref:`appc` + +Application Authorization Framework +----------------------------------- + +.. toctree:: + :maxdepth: 2 + :titlesonly: + +| :ref:`aaf authz` +| :ref:`Secret Management Service` + +Command Line Interface +---------------------- + +.. toctree:: + :maxdepth: 2 + :titlesonly: + +: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 ------------------------------------------ @@ -49,21 +71,11 @@ Common Controller Software Development Kit :maxdepth: 2 :titlesonly: - ../../../submodules/ccsdk/distribution.git/docs/index - ../../../submodules/ccsdk/dashboard.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/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 - ../../../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 ------------------------------------- @@ -72,7 +84,26 @@ Data Collection, Analysis, and Events :maxdepth: 2 :titlesonly: - ../../../submodules/dcaegen2.git/docs/index +:ref:`dcaegen2` + +Data Management as a Platform Data Bus Controller +------------------------------------------------- + +.. toctree:: + :maxdepth: 1 + :titlesonly: + +| :ref:`dmaap dbcapi` +| :ref:`dmaap buscontroller` + +Data Management as a Platform Data Router +----------------------------------------- + +.. toctree:: + :maxdepth: 1 + :titlesonly: + +:ref:`dmaap datarouter` Data Management as a Platform Message Router -------------------------------------------- @@ -81,16 +112,16 @@ Data Management as a Platform Message Router :maxdepth: 2 :titlesonly: - ../../../submodules/dmaap/messagerouter/messageservice.git/docs/index +:ref:`dmaap messagerouter messageservice` -Documentation -------------- +External API Framework +---------------------- .. toctree:: :maxdepth: 2 :titlesonly: - ../how-to-use-docs/index.rst +:ref:`externalapi nbi` Holmes @@ -100,23 +131,26 @@ 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 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 `. +.. toctree:: + :maxdepth: 1 + :titlesonly: + +:ref:`integration` -Logging Enhancements Project ----------------------------- +Logging Analytics +----------------- .. toctree:: :maxdepth: 2 :titlesonly: - ../../../submodules/logging-analytics.git/docs/index +:ref:`logging-analytics` Micro Services Bus ------------------ @@ -125,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 @@ -140,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 -------------- @@ -150,44 +182,39 @@ MultiVIM Cloud :maxdepth: 2 :titlesonly: - ../../../submodules/multicloud/framework.git/docs/index +:ref:`multicloud framework` +Music +----- -Nokia SVNFM driver ------------------- - .. toctree:: :maxdepth: 2 :titlesonly: - - ../../../submodules/vfc/svnfm.git/nokiav2/docs/index -ONAP Command Line Interface ---------------------------- - -.. toctree:: - :maxdepth: 2 - :titlesonly: +:ref:`music` - ../../../submodules/cli.git/docs/index +:ref:`music distributed-kv-store` -ONAP Operations Manager (experimental) --------------------------------------- +ONAP Operations Manager +----------------------- .. toctree:: :maxdepth: 2 :titlesonly: - ../../../submodules/oom.git/docs/index +| :ref:`oom` +| :ref:`oom/platform/cert-service` -ONAP Use Case User Interface ----------------------------- +Optimization Framework +---------------------- .. toctree:: :maxdepth: 2 :titlesonly: - ../../../submodules/usecase-ui.git/docs/index +| :ref:`optf has` +| :ref:`optf osdf` +| :ref:`optf cmso` Policy Framework ---------------- @@ -196,7 +223,9 @@ Policy Framework :maxdepth: 2 :titlesonly: - ../../../submodules/policy/engine.git/docs/index +:ref:`policy parent` + +:ref:`policy engine` Portal Platform --------------- @@ -205,7 +234,7 @@ Portal Platform :maxdepth: 2 :titlesonly: - ../../../submodules/portal.git/docs/index +:ref:`portal` Service Design & Creation ------------------------- @@ -214,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 --------------------- @@ -231,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 ----------------------------------- @@ -241,49 +263,44 @@ 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 - -Virtual Function Controller ---------------------------- +Software Defined Network Controller for Radio (SDN-R) +----------------------------------------------------- .. toctree:: :maxdepth: 2 :titlesonly: - ../../../submodules/vfc/nfvo/lcm.git/docs/index +:ref:`ccsdk features` -Virtual Infrastructure Deployment ---------------------------------- +Use Case User Interface +----------------------- .. toctree:: :maxdepth: 2 :titlesonly: +:ref:`usecase-ui` + +Virtual Function Controller +--------------------------- - ../../../submodules/vid.git/docs/index +.. toctree:: + :maxdepth: 2 + :titlesonly: -.. Empty folders for this release - ../../../submodules/vid/asdcclient.git/docs/index +:ref:`vfc nfvo lcm` -VNF Requirements ----------------- +Virtual Infrastructure Deployment +--------------------------------- .. toctree:: :maxdepth: 2 :titlesonly: - ../../../submodules/vnfrqts/guidelines.git/docs/index - ../../../submodules/vnfrqts/requirements.git/docs/index +:ref:`vid` VNF Software Development Kit ---------------------------- @@ -292,4 +309,4 @@ VNF Software Development Kit :maxdepth: 2 :titlesonly: - ../../../submodules/vnfsdk/model.git/docs/index +:ref:`vnfsdk model`