diff options
Diffstat (limited to 'docs/guides/onap-developer')
5 files changed, 109 insertions, 104 deletions
diff --git a/docs/guides/onap-developer/apiref/index.rst b/docs/guides/onap-developer/apiref/index.rst index 289855ba8..fc7ddcdfb 100644 --- a/docs/guides/onap-developer/apiref/index.rst +++ b/docs/guides/onap-developer/apiref/index.rst @@ -20,10 +20,10 @@ User Interfaces :maxdepth: 1 :titlesonly: - CLAMP - Closed Loop Automation Platform <../../../submodules/clamp.git/docs/index.rst> - Portal <../../../submodules/portal.git/docs/platform/offeredapis.rst> - SDC - Service Design and Creation <../../../submodules/sdc.git/docs/offeredapis.rst> - VID - Virtual Infrastructure Deployment <../../../submodules/vid.git/docs/offeredapis.rst> +:ref:`CLAMP - Closed Loop Automation Platform<onap-clamp:master_index>` +:ref:`Portal<onap-portal:offeredapis>` +:ref:`SDC - Service Design and Creation<onap-sdc:offeredapis>` +:ref:`VID - Virtual Infrastructure Deployment<onap-vid:offeredapis>` Platform Components ------------------- @@ -32,13 +32,13 @@ Platform Components :maxdepth: 1 :titlesonly: - APPC - Application Controller <../../../submodules/appc.git/docs/index.rst> - DCAE - Data Collection, Analytics, and Events <../../../submodules/dcaegen2.git/docs/sections/offeredapis.rst> - Holmes - Alarm Correlation <../../../submodules/holmes/rule-management.git/docs/platform/offeredapis.rst> - Policy <../../../submodules/policy/parent.git/docs/offeredapis.rst> - SDNC - SDN Controller <../../../submodules/sdnc/oam.git/docs/offeredapis.rst> - SO - Service Orchestration <../../../submodules/so.git/docs/api/offered_consumed_apis.rst> - VFC - Virtual Function Controller <../../../submodules/vfc/nfvo/lcm.git/docs/platform/APIs/index.rst> +:ref:`APPC - Application Controller<onap-appc:appc_lcm_api_guide>` +:ref:`DCAE - Data Collection Analytics and Events<onap-dcaegen2:offeredapis>` +:ref:`Holmes - Alarm Correlation<onap-holmes-rule-management:offeredapis>` +:ref:`Policy<onap-policy-parent:offeredapis>` +:ref:`SDNC - SDN Controller<onap-sdnc-oam:offeredapis>` +:ref:`SO - Service Orchestration<onap-so:offeredapis>` +:ref:`VFC - Virtual Function Controller<onap-vfc-nfvo-lcm:master_index>` Common Services --------------- @@ -47,18 +47,18 @@ Common Services :maxdepth: 1 :titlesonly: - AAF - Application Authorization Framework <../../../submodules/aaf/sms.git/docs/api.rst> - AAI - Active and Available Inventory <../../../submodules/aai/aai-common.git/docs/AAI REST API Documentation/AAIRESTAPI.rst> - AAI ESR - AAI External System Register <../../../submodules/aai/esr-server.git/docs/offeredapis.rst> - DMAAP DBC - Data Management as a Platform (Data Bus Controller) <../../../submodules/dmaap/dbcapi.git/docs/api.rst> - DMAAP DR - Data Management as a Platform (Data Router) <../../../submodules/dmaap/datarouter.git/docs/index.rst> - DMAAP MR - Data Management as a Platform (Message Router) <../../../submodules/dmaap/messagerouter/messageservice.git/docs/offeredapis/offeredapis.rst> - ExtAPI- External API/NBI - NorthBound API <../../../submodules/externalapi/nbi.git/docs/offeredapis/offeredapis.rst> - Modeling Parsers <../../../submodules/modeling/toscaparsers.git/docs/offeredapis.rst> - MSB - Micro Services Bus <../../../submodules/msb/apigateway.git/docs/platform/offeredapis.rst> - Multi Cloud <../../../submodules/multicloud/framework.git/docs/MultiCloud-APIv1-Specification.rst> - MUSIC - Multi-site State Coordination Service <../../../submodules/music.git/docs/offeredapis.rst> - OPTF - Optimization Framework <../../../submodules/optf/osdf.git/docs/sections/offeredapis.rst> +:ref:`AAF - Application Authorization Framework<onap-aaf-sms:offeredapis>` +:ref:`AAI - Active and Available Inventory<onap-aai-aai-common:offeredapis>` +:ref:`AAI ESR - AAI External System Register<onap-aai-esr-server:offeredapis>` +:ref:`DMAAP DBC - Data Management as a Platform (Data Bus Controller)<onap-dmaap-dbcapi:offeredapis>` +:ref:`DMAAP DR - Data Management as a Platform (Data Router)<onap-dmaap-datarouter:master_index>` +:ref:`DMAAP MR - Data Management as a Platform (Message Router)<onap-dmaap-messagerouter-messageservice:offeredapis>` +:ref:`ExtAPI- External API NBI - NorthBound API<onap-externalapi-nbi:offeredapis>` +:ref:`Modeling Parsers<onap-modeling-toscaparsers:offeredapis>` +:ref:`MSB - Micro Services Bus<onap-msb-apigateway:offeredapis>` +:ref:`Multi Cloud<onap-multicloud-framework:offeredapis>` +:ref:`MUSIC - Multi-site State Coordination Service<onap-music:offeredapis>` +:ref:`OPTF - Optimization Framework<onap-optf-osdf:offeredapis>` SDK --- @@ -67,7 +67,7 @@ SDK :maxdepth: 1 :titlesonly: - VNF Software Development Kit <../../../submodules/vnfsdk/model.git/docs/files/vnfsdk-apis.rst> +:ref:`VNF Software Development Kit<onap-vnfsdk-model:offeredapis>` Some ONAP Postman collections @@ -77,4 +77,4 @@ Some ONAP Postman collections :maxdepth: 1 :titlesonly: - Some ONAP Postman collections <../../../submodules/integration.git/docs/docs_postman.rst> +:ref:`Some ONAP Postman collections<onap-integration:docs_postman>` diff --git a/docs/guides/onap-developer/architecture/references.rst b/docs/guides/onap-developer/architecture/references.rst index a6dcdd98d..5c3dcac04 100644 --- a/docs/guides/onap-developer/architecture/references.rst +++ b/docs/guides/onap-developer/architecture/references.rst @@ -20,7 +20,7 @@ Models :maxdepth: 1 :titlesonly: - Model Specifications <../../../submodules/modeling/modelspec.git/docs/index> +:ref:`Model Specifications<onap-modeling-modelspec:master_index>` User Interfaces --------------- @@ -29,13 +29,13 @@ User Interfaces :maxdepth: 1 :titlesonly: - APPC CDT - Application Controller Design Tool <../../../submodules/appc.git/docs/APPC CDT Guide/APPC CDT Guide.rst> - CLAMP - Closed Loop Automation Platform <../../../submodules/clamp.git/docs/architecture.rst> - CLI - Command Line Interface <../../../submodules/cli.git/docs/architecture.rst> - PORTAL <../../../submodules/portal.git/docs/platform/architecture.rst> - SDC - Service Design and Creation <../../../submodules/sdc.git/docs/architecture.rst> - UUI- Usecase UI <../../../submodules/usecase-ui.git/docs/platform/architecture.rst> - VID - Virtual Infrastructure Deployment <../../../submodules/vid.git/docs/architecture.rst> +| :ref:`APPC CDT Application Controller Design Tool<onap-appc:appc_lcm_api_guide>` +| :ref:`CLAMP - Closed Loop Automation Platform<onap-clamp:architecture>` +| :ref:`CLI - Command Line Interface<onap-cli:architecture>` +| :ref:`PORTAL<onap-portal:architecture>` +| :ref:`SDC - Service Design and Creation<onap-sdc:architecture>` +| :ref:`UUI- Usecase UI<onap-usecase-ui:architecture>` +| :ref:`VID - Virtual Infrastructure Deployment<onap-vid:architecture>` Platform Components ------------------- @@ -44,13 +44,13 @@ Platform Components :maxdepth: 1 :titlesonly: - APPC - Application Controller <../../../submodules/appc.git/docs/APPC User Guide/APPC User Guide.rst> - DCAE - Data Collection Analytics and Events <../../../submodules/dcaegen2.git/docs/sections/architecture.rst> - Holmes <../../../submodules/holmes/rule-management.git/docs/platform/architecture.rst> - Policy <../../../submodules/policy/engine.git/docs/platform/architecture.rst> - SDNC - SDN Controller OAM <../../../submodules/sdnc/oam.git/docs/architecture.rst> - SO - Service Orchestrator <../../../submodules/so.git/docs/architecture/architecture.rst> - VFC - Virtual Function Controller <../../../submodules/vfc/nfvo/lcm.git/docs/platform/architecture.rst> +| :ref:`APPC - Application Controller<onap-appc:master_index>` +| :ref:`DCAE - Data Collection Analytics and Events<onap-dcaegen2:architecture>` +| :ref:`Holmes<onap-holmes-rule-management:architecture>` +| :ref:`Policy<onap-policy-engine:architecture>` +| :ref:`SDNC - SDN Controller OAM<onap-sdnc-oam:architecture>` +| :ref:`SO - Service Orchestrator<onap-so:architecture>` +| :ref:`VFC - Virtual Function Controller<onap-vfc-nfvo-lcm:architecture>` Common Services --------------- @@ -59,16 +59,16 @@ Common Services :maxdepth: 1 :titlesonly: - AAF - Application Authorization Framework <../../../submodules/aaf/authz.git/docs/sections/architecture/index.rst> - AAI - Active and Available Inventory <../../../submodules/aai/aai-common.git/docs/platform/architecture.rst> - AAI ESR <../../../submodules/aai/esr-gui.git/docs/platform/architecture.rst> - DMAAP MR - Data Management as a Platform (Message Router) <../../../submodules/dmaap/messagerouter/messageservice.git/docs/architecture/architecture.rst> - ExtAPI - External API/NBI <../../../submodules/externalapi/nbi.git/docs/architecture/architecture.rst> - Logging Framework - <../../../submodules/logging-analytics.git/docs/Logging_User_Guide/logging_user_guide.rst> - MSB - Microservices Bus <../../../submodules/msb/apigateway.git/docs/platform/architecture.rst> - Multi Cloud <../../../submodules/multicloud/framework.git/docs/MultiCloud-Administrator-Guide.rst> - MUSIC - Multi-site State Coordination Service <../../../submodules/music.git/docs/architecture.rst> - OOM - ONAP Operations Manager <../../../submodules/oom.git/docs/oom_project_description.rst> - OPTF - Optimization Framework <../../../submodules/optf/osdf.git/docs/sections/architecture.rst> - VNF SDK <../../../submodules/vnfsdk/model.git/docs/files/vnfsdk-apis.rst> +| :ref:`AAF - Application Authorization Framework<onap-aaf-authz:master_index>` +| :ref:`AAI - Active and Available Inventory<onap-aai-aai-common:architecture>` +| :ref:`AAI ESR<onap-aai-esr-gui:architecture>` +| :ref:`DMAAP MR - Data Management as a Platform (Message Router)<onap-dmaap-messagerouter-messageservice:architecture>` +| :ref:`ExtAPI - External API NBI<onap-externalapi-nbi:architecture>` +| :ref:`Logging Framework -<onap-logging-analytics:logging_user_guide>` +| :ref:`MSB - Microservices Bus<onap-msb-apigateway:architecture>` +| :ref:`Multi Cloud<onap-multicloud-framework:multicloud-administrator-guide>` +| :ref:`MUSIC - Multi-site State Coordination Service<onap-music:architecture>` +| :ref:`OOM - ONAP Operations Manager<onap-oom:oom_project_description>` +| :ref:`OPTF - Optimization Framework<onap-optf-osdf:architecture>` +| :ref:`VNF SDK<onap-vnfsdk-model:offeredapis>` diff --git a/docs/guides/onap-developer/developing/index.rst b/docs/guides/onap-developer/developing/index.rst index 0b09cfb78..e0bc103a3 100644 --- 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,9 +42,9 @@ Application Authorization Framework :maxdepth: 2 :titlesonly: - ../../../submodules/aaf/authz.git/docs/index - Secret Management Service <../../../submodules/aaf/sms.git/docs/index> - Certification Service <../../../submodules/aaf/certservice.git/docs/index> +| :ref:`aaf authz<onap-aaf-authz:master_index>` +| :ref:`Secret Management Service<onap-aaf-sms:master_index>` +| :ref:`Certification Service<onap-aaf-certservice:master_index>` Command Line Interface ---------------------- @@ -53,7 +53,7 @@ Command Line Interface :maxdepth: 2 :titlesonly: - ../../../submodules/cli.git/docs/index +:ref:`cli<onap-cli:master_index>` Control Loop Automation Management Platform @@ -63,7 +63,7 @@ Control Loop Automation Management Platform :maxdepth: 2 :titlesonly: - ../../../submodules/clamp.git/docs/index +:ref:`clamp<onap-clamp:master_index>` Common Controller Software Development Kit ------------------------------------------ @@ -72,11 +72,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 +| :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 ------------------------------------- @@ -85,7 +85,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 ------------------------------------------------- @@ -94,8 +94,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 ----------------------------------------- @@ -104,7 +104,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 -------------------------------------------- @@ -113,7 +113,7 @@ Data Management as a Platform Message Router :maxdepth: 2 :titlesonly: - ../../../submodules/dmaap/messagerouter/messageservice.git/docs/index +:ref:`dmaap messagerouter messageservice<onap-dmaap-messagerouter-messageservice:master_index>` External API Framework ---------------------- @@ -122,7 +122,7 @@ External API Framework :maxdepth: 2 :titlesonly: - ../../../submodules/externalapi/nbi.git/docs/index +:ref:`externalapi nbi<onap-externalapi-nbi:master_index>` Holmes @@ -132,8 +132,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 ----------- @@ -142,7 +142,7 @@ Integration :maxdepth: 1 :titlesonly: - ../../../submodules/integration.git/docs/index +:ref:`integration<onap-integration:master_index>` Logging Analytics ----------------- @@ -151,7 +151,7 @@ Logging Analytics :maxdepth: 2 :titlesonly: - ../../../submodules/logging-analytics.git/docs/index +:ref:`logging-analytics<onap-logging-analytics:master_index>` Micro Services Bus ------------------ @@ -160,8 +160,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>` + +:ref:`msb swagger-sdk<onap-msb-swagger-sdk:master_index>` Modeling @@ -171,8 +172,9 @@ Modeling :maxdepth: 2 :titlesonly: - ../../../submodules/modeling/modelspec.git/docs/index - ../../../submodules/modeling/etsicatalog.git/docs/index +:ref:`modeling modelspec<onap-modeling-modelspec:master_index>` + +:ref:`modeling etsicatalog<onap-modeling-etsicatalog:master_index>` MultiVIM Cloud -------------- @@ -181,7 +183,7 @@ MultiVIM Cloud :maxdepth: 2 :titlesonly: - ../../../submodules/multicloud/framework.git/docs/index +:ref:`multicloud framework<onap-multicloud-framework:master_index>` Music ----- @@ -190,8 +192,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 ----------------------- @@ -200,7 +203,7 @@ ONAP Operations Manager :maxdepth: 2 :titlesonly: - ../../../submodules/oom.git/docs/index +:ref:`oom<onap-oom:master_index>` Optimization Framework ---------------------- @@ -209,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 ---------------- @@ -220,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 --------------- @@ -230,7 +234,7 @@ Portal Platform :maxdepth: 2 :titlesonly: - ../../../submodules/portal.git/docs/index +:ref:`portal<onap-portal:master_index>` Service Design & Creation ------------------------- @@ -239,7 +243,7 @@ Service Design & Creation :maxdepth: 2 :titlesonly: - ../../../submodules/sdc.git/docs/index +:ref:`sdc<onap-sdc:master_index>` Service Orchestration --------------------- @@ -248,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 ----------------------------------- @@ -258,7 +263,7 @@ Software Defined Network Controller :maxdepth: 2 :titlesonly: - ../../../submodules/sdnc/oam.git/docs/index +:ref:`sdnc oam<onap-sdnc-oam:master_index>` Software Defined Network Controller for Radio (SDN-R) ----------------------------------------------------- @@ -267,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 ----------------------- @@ -276,7 +281,7 @@ Use Case User Interface :maxdepth: 2 :titlesonly: - ../../../submodules/usecase-ui.git/docs/index +:ref:`usecase-ui<onap-usecase-ui:master_index>` Virtual Function Controller --------------------------- @@ -285,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 --------------------------------- @@ -295,7 +300,7 @@ Virtual Infrastructure Deployment :titlesonly: - ../../../submodules/vid.git/docs/index +:ref:`vid<onap-vid:master_index>` VNF Software Development Kit ---------------------------- @@ -304,4 +309,4 @@ VNF Software Development Kit :maxdepth: 2 :titlesonly: - ../../../submodules/vnfsdk/model.git/docs/index +:ref:`vnfsdk model<onap-vnfsdk-model:master_index>` diff --git a/docs/guides/onap-developer/how-to-use-docs/addendum.rst b/docs/guides/onap-developer/how-to-use-docs/addendum.rst index ba35dcce1..e3b209cbe 100644 --- a/docs/guides/onap-developer/how-to-use-docs/addendum.rst +++ b/docs/guides/onap-developer/how-to-use-docs/addendum.rst @@ -102,7 +102,7 @@ When your project is built, Sphinx will generate an index page populated with th you created in the source RST. These are simple cases with simple options. For more information about indexing with Sphinx, -please see the `official Sphinx documentation <http://www.sphinx-doc.org/en/stable/markup/misc.html#directive-index>`_. +please see the `official Sphinx documentation <http://www.sphinx-doc.org/en/stable/markup/misc.html>`_. Jenkins Jobs diff --git a/docs/guides/onap-developer/how-to-use-docs/include-documentation.rst b/docs/guides/onap-developer/how-to-use-docs/include-documentation.rst index af46d6404..8fc6595b6 100644 --- a/docs/guides/onap-developer/how-to-use-docs/include-documentation.rst +++ b/docs/guides/onap-developer/how-to-use-docs/include-documentation.rst @@ -368,7 +368,7 @@ It's pretty common to want to reference another location in the ONAP documentation and it's pretty easy to do with reStructuredText. This is a quick primer, more information is in the `Sphinx section on Cross-referencing arbitrary locations -<http://www.sphinx-doc.org/en/stable/markup/inline.html#ref-role>`_. +<http://www.sphinx-doc.org/en/stable/markup/inline.html>`_. Within a single document, you can reference another section simply by:: |