diff options
| -rw-r--r-- | docs/guides/onap-developer/architecture/index.rst | 3 | ||||
| -rw-r--r-- | docs/guides/onap-developer/developing/index.rst | 291 | ||||
| -rw-r--r-- | docs/guides/onap-developer/index.rst | 4 | ||||
| -rw-r--r-- | docs/release/releaserepos.rst | 130 |
4 files changed, 358 insertions, 70 deletions
diff --git a/docs/guides/onap-developer/architecture/index.rst b/docs/guides/onap-developer/architecture/index.rst index 1bb57cfaf..bc392893c 100644 --- a/docs/guides/onap-developer/architecture/index.rst +++ b/docs/guides/onap-developer/architecture/index.rst @@ -76,7 +76,6 @@ Common Services :maxdepth: 1 :titlesonly: - ../../../submodules/aaf/authz.git/docs/architecture.rst AAI - Active and Available Inventory <../../../submodules/aai/aai-common.git/docs/platform/architecture.rst> AAI ESR UI <../../../submodules/aai/esr-gui.git/docs/platform/architecture.rst> AAI ESR Server <../../../submodules/aai/esr-server.git/docs/platform/architecture.rst> @@ -86,8 +85,6 @@ Common Services ../../../submodules/msb/discovery.git/docs/architecture.rst ../../../submodules/msb/java-sdk.git/docs/architecture.rst ../../../submodules/msb/swagger-sdk.git/docs/architecture.rst - ../../../submodules/multicloud/framework.git/docs/architecture.rst - ../../../submodules/oom.git/docs/architecture.rst SDKs ---- diff --git a/docs/guides/onap-developer/developing/index.rst b/docs/guides/onap-developer/developing/index.rst index a45b3dc06..7ce12034b 100644 --- a/docs/guides/onap-developer/developing/index.rst +++ b/docs/guides/onap-developer/developing/index.rst @@ -6,9 +6,296 @@ Developing ONAP =============== -Additional developer level detail is provided for each project and component below. +Additional developer level detail is provided for each project below. + +Active and Available Inventory +------------------------------ + +.. toctree:: + :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 + + +Application Controller +---------------------- + +.. toctree:: + :maxdepth: 2 + :titlesonly: + + ../../../submodules/appc/deployment.git/docs/index + ../../../submodules/appc.git/docs/index + +Closed Loop Automation Platform +------------------------------- + +.. toctree:: + :maxdepth: 2 + :titlesonly: + + ../../../submodules/clamp.git/docs/index + +Common Controller Software Development Kit +------------------------------------------ + +.. toctree:: + :maxdepth: 2 + :titlesonly: + + ../../../submodules/ccsdk/distribution.git/docs/index + ../../../submodules/ccsdk/dashboard.git/docs/index + ../../../submodules/ccsdk/platform/plugins.git/docs/index + +.. Empty Folders for Release + ../../../submodules/ccsdk/parent.git/docs/index + ../../../submodules/ccsdk/platform/blueprints.git/docs/index + ../../../submodules/ccsdk/platform/nbapi.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 + ../../../submodules/ccsdk/storage/esaas.git/docs/index + ../../../submodules/ccsdk/storage/pgaas.git/docs/index + ../../../submodules/ccsdk/utils.git/docs/index + +Data Collection, Analysis, and Events +------------------------------------- + +.. toctree:: + :maxdepth: 2 + :titlesonly: + + ../../../submodules/dcaegen2.git/docs/index + +Data Management as a Platform Message Router +-------------------------------------------- + +.. toctree:: + :maxdepth: 2 + :titlesonly: + + ../../../submodules/dmaap/messagerouter/messageservice.git/docs/index + +Documentation +------------- + +.. toctree:: + :maxdepth: 2 + :titlesonly: + + ../how-to-use-docs/index.rst + +External API Framework +---------------------- + +.. toctree:: + :maxdepth: 2 + :titlesonly: + + +Holmes +------ + +.. toctree:: + :maxdepth: 2 + :titlesonly: + + Alarm Correlation and Analysis <../../../submodules/holmes/engine-management.git/docs/index> + Architecture and APIs <../../../submodules/holmes/rule-management.git/docs/index> + +Integration +----------- + +.. toctree:: + :maxdepth: 2 + :titlesonly: + + ../../../submodules/integration.git/docs/index + +Logging Enhancements Project +---------------------------- + +.. toctree:: + :maxdepth: 2 + :titlesonly: + + ../../../submodules/logging-analytics.git/docs/index + +Micro Services Bus +------------------ + +.. toctree:: + :maxdepth: 2 + :titlesonly: + + ../../../submodules/msb/apigateway.git/docs/index + ../../../submodules/msb/swagger-sdk.git/docs/index + +.. Empty folders in this release + ../../../submodules/msb/discovery.git/docs/index + ../../../submodules/msb/java-sdk.git/docs/index + + +Modeling +-------- + +.. toctree:: + :maxdepth: 2 + :titlesonly: + + ../../../submodules/modeling/modelspec.git/docs/index + ../../../submodules/modeling/toscaparsers.git/docs/index + +ONAP Command Line Interface +--------------------------- + +.. toctree:: + :maxdepth: 2 + :titlesonly: + + ../../../submodules/cli.git/docs/index + + +ONAP Optimization Framework +--------------------------- + +.. toctree:: + :maxdepth: 2 + :titlesonly: + + ../../../submodules/optf/has.git/docs/index + +ONAP University +--------------- + +.. toctree:: + :maxdepth: 2 + :titlesonly: + + +ONAP Use Case User Interface +---------------------------- + +.. toctree:: + :maxdepth: 2 + :titlesonly: + + ../../../submodules/usecase-ui.git/docs/index + +Policy Framework +---------------- + +.. toctree:: + :maxdepth: 2 + :titlesonly: + + ../../../submodules/policy/engine.git/docs/index + +Portal Platform +--------------- + +.. toctree:: + :maxdepth: 2 + :titlesonly: + + ../../../submodules/portal.git/docs/index + +Service Design & Creation +------------------------- + +.. toctree:: + :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 + +Service Orchestration +--------------------- + +.. toctree:: + :maxdepth: 2 + :titlesonly: + + ../../../submodules/so.git/docs/index + ../../../submodules/so/libs.git/docs/index + +Software Defined Network Controller +----------------------------------- + +.. toctree:: + :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 + +Virtual Function Controller +--------------------------- + +.. toctree:: + :maxdepth: 2 + :titlesonly: + + ../../../submodules/vfc/nfvo/lcm.git/docs/index + +Virtual Infrastructure Deployment +--------------------------------- + +.. toctree:: + :maxdepth: 2 + :titlesonly: + + + ../../../submodules/vid.git/docs/index + +.. 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 +---------------------------- + +.. toctree:: + :maxdepth: 2 + :titlesonly: + + ../../../submodules/vnfsdk/model.git/docs/index + +VNF Validation +-------------- .. toctree:: :maxdepth: 2 + :titlesonly: - ../../../../../release/repolist.rst diff --git a/docs/guides/onap-developer/index.rst b/docs/guides/onap-developer/index.rst index 13c7372cb..11a451823 100644 --- a/docs/guides/onap-developer/index.rst +++ b/docs/guides/onap-developer/index.rst @@ -4,10 +4,10 @@ ONAP Developer ============== -Describe the kinds of references, tutorials, specifications provided for developers. +Documentation for developers. .. toctree:: - :maxdepth: 2 + :maxdepth: 1 architecture/index tutorials/index diff --git a/docs/release/releaserepos.rst b/docs/release/releaserepos.rst index b717a890d..7d445f922 100644 --- a/docs/release/releaserepos.rst +++ b/docs/release/releaserepos.rst @@ -12,66 +12,70 @@ Project Specific Release Notes :maxdepth: 1 :titlesonly: - Release Notes for aaf/authz<../submodules/aaf/authz.git/docs/release-notes.rst> - Release Notes for aai/aai-common<../submodules/aai/aai-common.git/docs/release-notes.rst> - Release Notes for aai/esr-gui<../submodules/aai/esr-gui.git/docs/release-notes.rst> - Release Notes for aai/esr-server<../submodules/aai/esr-server.git/docs/release-notes.rst> - Release Notes for aai/sparky-be<../submodules/aai/sparky-be.git/docs/release-notes.rst> - Release Notes for appc/deployment<../submodules/appc/deployment.git/docs/release-notes.rst> - Release Notes for appc<../submodules/appc.git/docs/release-notes.rst> - Release Notes for ccsdk/dashboard<../submodules/ccsdk/dashboard.git/docs/release-notes.rst> - Release Notes for ccsdk/distribution<../submodules/ccsdk/distribution.git/docs/release-notes.rst> - Release Notes for ccsdk/parent<../submodules/ccsdk/parent.git/docs/release-notes.rst> - Release Notes for ccsdk/platform/blueprints<../submodules/ccsdk/platform/blueprints.git/docs/release-notes.rst> - Release Notes for ccsdk/platform/nbapi<../submodules/ccsdk/platform/nbapi.git/docs/release-notes.rst> - Release Notes for ccsdk/platform/plugins<../submodules/ccsdk/platform/plugins.git/docs/release-notes.rst> - Release Notes for ccsdk/sli/adaptors<../submodules/ccsdk/sli/adaptors.git/docs/release-notes.rst> - Release Notes for ccsdk/sli/core<../submodules/ccsdk/sli/core.git/docs/release-notes.rst> - Release Notes for ccsdk/sli/northbound<../submodules/ccsdk/sli/northbound.git/docs/release-notes.rst> - Release Notes for ccsdk/sli/plugins<../submodules/ccsdk/sli/plugins.git/docs/release-notes.rst> - Release Notes for ccsdk/storage/esaas<../submodules/ccsdk/storage/esaas.git/docs/release-notes.rst> - Release Notes for ccsdk/storage/pgaas<../submodules/ccsdk/storage/pgaas.git/docs/release-notes.rst> - Release Notes for ccsdk/utils<../submodules/ccsdk/utils.git/docs/release-notes.rst> - Release Notes for clamp<../submodules/clamp.git/docs/release-notes.rst> - Release Notes for cli<../submodules/cli.git/docs/release-notes.rst> - Release Notes for dcaegen2<../submodules/dcaegen2.git/docs/sections/release-notes.rst> - Release Notes for doc <../release-notes.rst> - Release Notes for dmaap/messagerouter/messageservice<../submodules/dmaap/messagerouter/messageservice.git/docs/release-notes.rst> - Release Notes for holmes/engine-management<../submodules/holmes/engine-management.git/docs/release-notes.rst> - Release Notes for holmes/rule-management<../submodules/holmes/rule-management.git/docs/release-notes.rst> - Release Notes for integration<../submodules/integration.git/docs/release-notes.rst> - Release Notes for modeling/modelspec<../submodules/modeling/modelspec.git/docs/release-notes.rst> - Release Notes for msb/apigateway<../submodules/msb/apigateway.git/docs/release-notes.rst> - Release Notes for msb/discovery<../submodules/msb/discovery.git/docs/release-notes.rst> - Release Notes for msb/java-sdk<../submodules/msb/java-sdk.git/docs/release-notes.rst> - Release Notes for msb/swagger-sdk<../submodules/msb/swagger-sdk.git/docs/release-notes.rst> - Release Notes for multicloud/framework<../submodules/multicloud/framework.git/docs/release-notes.rst> - Release Notes for oom<../submodules/oom.git/docs/release-notes.rst> - Release Notes for optf/has<../submodules/optf/has.git/docs/release-notes.rst> - Release Notes for policy/engine<../submodules/policy/engine.git/docs/release-notes.rst> - Release Notes for portal<../submodules/portal.git/docs/release-notes.rst> - Release Notes for sdc<../submodules/sdc.git/docs/release-notes.rst> - Release Notes for sdc/jtosca<../submodules/sdc/jtosca.git/docs/release-notes.rst> - Release Notes for sdc/sdc-distribution-client<../submodules/sdc/sdc-distribution-client.git/docs/release-notes.rst> - Release Notes for sdc/sdc-docker-base<../submodules/sdc/sdc-docker-base.git/docs/release-notes.rst> - Release Notes for sdc/sdc-titan-cassandra<../submodules/sdc/sdc-titan-cassandra.git/docs/release-notes.rst> - Release Notes for sdc/sdc-tosca<../submodules/sdc/sdc-tosca.git/docs/release-notes.rst> - Release Notes for sdc/sdc-workflow-designer<../submodules/sdc/sdc-workflow-designer.git/docs/release-notes.rst> - Release Notes for sdnc/adaptors<../submodules/sdnc/adaptors.git/docs/release-notes.rst> - Release Notes for sdnc/architecture<../submodules/sdnc/architecture.git/docs/release-notes.rst> - Release Notes for sdnc/core<../submodules/sdnc/core.git/docs/release-notes.rst> - Release Notes for sdnc/features<../submodules/sdnc/features.git/docs/release-notes.rst> - Release Notes for sdnc/northbound<../submodules/sdnc/northbound.git/docs/release-notes.rst> - Release Notes for sdnc/oam<../submodules/sdnc/oam.git/docs/release-notes.rst> - Release Notes for sdnc/parent<../submodules/sdnc/parent.git/docs/release-notes.rst> - Release Notes for sdnc/plugins<../submodules/sdnc/plugins.git/docs/release-notes.rst> - Release Notes for so<../submodules/so.git/docs/release-notes.rst> - Release Notes for so/libs<../submodules/so/libs.git/docs/release-notes.rst> - Release Notes for usecase-ui<../submodules/usecase-ui.git/docs/release-notes.rst> - Release Notes for vfc/lcm<../submodules/vfc/lcm.git/docs/release-notes.rst> - Release Notes for vfc/nfvo/lcm<../submodules/vfc/nfvo/lcm.git/docs/release-notes.rst> - Release Notes for vid/asdcclient<../submodules/vid/asdcclient.git/docs/release-notes.rst> - Release Notes for vid<../submodules/vid.git/docs/release-notes.rst> - Release Notes for vnfrqts/guidelines<../submodules/vnfrqts/guidelines.git/docs/release-notes.rst> - Release Notes for vnfrqts/requirements<../submodules/vnfrqts/requirements.git/docs/release-notes.rst> - Release Notes for vnfsdk/model<../submodules/vnfsdk/model.git/docs/release-notes.rst> + aai/aai-common<../submodules/aai/aai-common.git/docs/release-notes.rst> + aai/esr-gui<../submodules/aai/esr-gui.git/docs/release-notes.rst> + aai/esr-server<../submodules/aai/esr-server.git/docs/release-notes.rst> + aai/sparky-be<../submodules/aai/sparky-be.git/docs/release-notes.rst> + appc/deployment<../submodules/appc/deployment.git/docs/release-notes.rst> + appc<../submodules/appc.git/docs/release-notes.rst> + ccsdk/distribution<../submodules/ccsdk/distribution.git/docs/release-notes.rst> + ccsdk/dashboard<../submodules/ccsdk/dashboard.git/docs/release-notes.rst> + ccsdk/platform/plugins<../submodules/ccsdk/platform/plugins.git/docs/release-notes.rst> + ccsdk/platform/blueprints<../submodules/ccsdk/platform/blueprints.git/docs/release-notes.rst> + + clamp<../submodules/clamp.git/docs/release-notes.rst> + cli<../submodules/cli.git/docs/release-notes.rst> + dcaegen2<../submodules/dcaegen2.git/docs/sections/release-notes.rst> + doc <../release-notes.rst> + dmaap/messagerouter/messageservice<../submodules/dmaap/messagerouter/messageservice.git/docs/release-notes.rst> + holmes/engine-management<../submodules/holmes/engine-management.git/docs/release-notes.rst> + holmes/rule-management<../submodules/holmes/rule-management.git/docs/release-notes.rst> + integration<../submodules/integration.git/docs/release-notes.rst> + modeling/modelspec<../submodules/modeling/modelspec.git/docs/release-notes.rst> + msb/apigateway<../submodules/msb/apigateway.git/docs/release-notes.rst> + msb/discovery<../submodules/msb/discovery.git/docs/release-notes.rst> + msb/java-sdk<../submodules/msb/java-sdk.git/docs/release-notes.rst> + msb/swagger-sdk<../submodules/msb/swagger-sdk.git/docs/release-notes.rst> + optf/has<../submodules/optf/has.git/docs/release-notes.rst> + policy/engine<../submodules/policy/engine.git/docs/release-notes.rst> + portal<../submodules/portal.git/docs/release-notes.rst> + sdc<../submodules/sdc.git/docs/release-notes.rst> + sdc/jtosca<../submodules/sdc/jtosca.git/docs/release-notes.rst> + sdc/sdc-distribution-client<../submodules/sdc/sdc-distribution-client.git/docs/release-notes.rst> + sdc/sdc-docker-base<../submodules/sdc/sdc-docker-base.git/docs/release-notes.rst> + sdc/sdc-titan-cassandra<../submodules/sdc/sdc-titan-cassandra.git/docs/release-notes.rst> + sdc/sdc-tosca<../submodules/sdc/sdc-tosca.git/docs/release-notes.rst> + sdc/sdc-workflow-designer<../submodules/sdc/sdc-workflow-designer.git/docs/release-notes.rst> + sdnc/oam<../submodules/sdnc/oam.git/docs/release-notes.rst> + so<../submodules/so.git/docs/release-notes.rst> + so/libs<../submodules/so/libs.git/docs/release-notes.rst> + usecase-ui<../submodules/usecase-ui.git/docs/release-notes.rst> + vfc/lcm<../submodules/vfc/lcm.git/docs/release-notes.rst> + vfc/nfvo/lcm<../submodules/vfc/nfvo/lcm.git/docs/release-notes.rst> + vid/asdcclient<../submodules/vid/asdcclient.git/docs/release-notes.rst> + vid<../submodules/vid.git/docs/release-notes.rst> + vnfrqts/guidelines<../submodules/vnfrqts/guidelines.git/docs/release-notes.rst> + vnfrqts/requirements<../submodules/vnfrqts/requirements.git/docs/release-notes.rst> + vnfsdk/model<../submodules/vnfsdk/model.git/docs/release-notes.rst> + + +.. Empty folders for this release + ccsdk/parent<../submodules/ccsdk/parent.git/docs/release-notes.rst> + ccsdk/platform/nbapi<../submodules/ccsdk/platform/nbapi.git/docs/release-notes.rst> + ccsdk/sli/adaptors<../submodules/ccsdk/sli/adaptors.git/docs/release-notes.rst> + ccsdk/sli/core<../submodules/ccsdk/sli/core.git/docs/release-notes.rst> + ccsdk/sli/northbound<../submodules/ccsdk/sli/northbound.git/docs/release-notes.rst> + ccsdk/sli/plugins<../submodules/ccsdk/sli/plugins.git/docs/release-notes.rst> + ccsdk/storage/esaas<../submodules/ccsdk/storage/esaas.git/docs/release-notes.rst> + ccsdk/storage/pgaas<../submodules/ccsdk/storage/pgaas.git/docs/release-notes.rst> + ccsdk/utils<../submodules/ccsdk/utils.git/docs/release-notes.rst> + sdnc/adaptors<../submodules/sdnc/adaptors.git/docs/release-notes.rst> + sdnc/architecture<../submodules/sdnc/architecture.git/docs/release-notes.rst> + sdnc/core<../submodules/sdnc/core.git/docs/release-notes.rst> + sdnc/features<../submodules/sdnc/features.git/docs/release-notes.rst> + sdnc/northbound<../submodules/sdnc/northbound.git/docs/release-notes.rst> + sdnc/parent<../submodules/sdnc/parent.git/docs/release-notes.rst> + sdnc/plugins<../submodules/sdnc/plugins.git/docs/release-notes.rst> + oom<../submodules/oom.git/docs/release-notes.rst> + multicloud/framework<../submodules/multicloud/framework.git/docs/release-notes.rst> + aaf/authz<../submodules/aaf/authz.git/docs/release-notes.rst> |