diff options
24 files changed, 254 insertions, 317 deletions
diff --git a/docs/guides/active-projects/index.rst b/docs/guides/active-projects/index.rst index c05067fdd..7e43bdd13 100644 --- a/docs/guides/active-projects/index.rst +++ b/docs/guides/active-projects/index.rst @@ -7,72 +7,72 @@ All Active Projects =================== -| :ref:`onap-oom-offline-installer <onap-oom-offline-installer:genindex>` -| :ref:`onap-oom <onap-oom:genindex>` -| :ref:`onap-oparent-cia <onap-oparent-cia:genindex>` -| :ref:`onap-music-distributed-kv-store <onap-music-distributed-kv-store:genindex>` -| :ref:`onap-dmaap-dbcapi <onap-dmaap-dbcapi:genindex>` -| :ref:`onap-msb-swagger-sdk <onap-msb-swagger-sdk:genindex>` -| :ref:`onap-msb-java-sdk <onap-msb-java-sdk:genindex>` -| :ref:`onap-holmes-engine-management <onap-holmes-engine-management:genindex>` -| :ref:`onap-multicloud-azure <onap-multicloud-azure:genindex>` -| :ref:`onap-modeling-etsicatalog <onap-modeling-etsicatalog:genindex>` -| :ref:`onap-modeling-toscaparsers <onap-modeling-toscaparsers:genindex>` -| :ref:`onap-modeling-modelspec <onap-modeling-modelspec:genindex>` -| :ref:`onap-vnfrqts-requirements <onap-vnfrqts-requirements:genindex>` -| :ref:`onap-vnfrqts-guidelines <onap-vnfrqts-guidelines:genindex>` -| :ref:`onap-dmaap-messagerouter-messageservice <onap-dmaap-messagerouter-messageservice:genindex>` -| :ref:`onap-externalapi-nbi <onap-externalapi-nbi:genindex>` -| :ref:`onap-logging-analytics <onap-logging-analytics:genindex>` -| :ref:`onap-dmaap-buscontroller <onap-dmaap-buscontroller:genindex>` -| :ref:`onap-dmaap-datarouter <onap-dmaap-datarouter:genindex>` -| :ref:`onap-music <onap-music:genindex>` -| :ref:`onap-sdc-sdc-workflow-designer <onap-sdc-sdc-workflow-designer:genindex>` -| :ref:`onap-sdc-sdc-tosca <onap-sdc-sdc-tosca:genindex>` -| :ref:`onap-vvp-documentation <onap-vvp-documentation:genindex>` -| :ref:`onap-logging-analytics-pomba-pomba-audit-common <onap-logging-analytics-pomba-pomba-audit-common:genindex>` -| :ref:`onap-msb-apigateway <onap-msb-apigateway:genindex>` -| :ref:`onap-msb-discovery <onap-msb-discovery:genindex>` -| :ref:`onap-vnfrqts-testcases <onap-vnfrqts-testcases:genindex>` -| :ref:`onap-vnfrqts-usecases <onap-vnfrqts-usecases:genindex>` -| :ref:`onap-policy-parent <onap-policy-parent:genindex>` -| :ref:`onap-vfc-nfvo-lcm <onap-vfc-nfvo-lcm:genindex>` -| :ref:`onap-vfc-nfvo-driver-vnfm-svnfm <onap-vfc-nfvo-driver-vnfm-svnfm:genindex>` -| :ref:`onap-holmes-rule-management <onap-holmes-rule-management:genindex>` -| :ref:`onap-policy-engine <onap-policy-engine:genindex>` -| :ref:`onap-portal <onap-portal:genindex>` -| :ref:`onap-cli <onap-cli:genindex>` -| :ref:`onap-aaf-certservice <onap-aaf-certservice:genindex>` -| :ref:`onap-ccsdk-cds <onap-ccsdk-cds:genindex>` -| :ref:`onap-ccsdk-apps <onap-ccsdk-apps:genindex>` -| :ref:`onap-sdnc-oam <onap-sdnc-oam:genindex>` -| :ref:`onap-ccsdk-platform-plugins <onap-ccsdk-platform-plugins:genindex>` -| :ref:`onap-ccsdk-dashboard <onap-ccsdk-dashboard:genindex>` -| :ref:`onap-ccsdk-features <onap-ccsdk-features:genindex>` -| :ref:`onap-ccsdk-distribution <onap-ccsdk-distribution:genindex>` -| :ref:`onap-so-libs <onap-so-libs:genindex>` -| :ref:`onap-so <onap-so:genindex>` -| :ref:`onap-integration <onap-integration:genindex>` -| :ref:`onap-aai-aai-common <onap-aai-aai-common:genindex>` -| :ref:`onap-aaf-sms <onap-aaf-sms:genindex>` -| :ref:`onap-appc <onap-appc:genindex>` -| :ref:`onap-appc-deployment <onap-appc-deployment:genindex>` -| :ref:`onap-optf-cmso <onap-optf-cmso:genindex>` -| :ref:`onap-optf-osdf <onap-optf-osdf:genindex>` -| :ref:`onap-optf-has <onap-optf-has:genindex>` -| :ref:`onap-sdc-sdc-distribution-client <onap-sdc-sdc-distribution-client:genindex>` -| :ref:`onap-sdc-sdc-docker-base <onap-sdc-sdc-docker-base:genindex>` -| :ref:`onap-sdc <onap-sdc:genindex>` -| :ref:`onap-clamp <onap-clamp:genindex>` -| :ref:`onap-aai-event-client <onap-aai-event-client:genindex>` -| :ref:`onap-aai-sparky-be <onap-aai-sparky-be:genindex>` -| :ref:`onap-aai-esr-gui <onap-aai-esr-gui:genindex>` -| :ref:`onap-aai-esr-server <onap-aai-esr-server:genindex>` -| :ref:`onap-multicloud-k8s <onap-multicloud-k8s:genindex>` -| :ref:`onap-multicloud-framework <onap-multicloud-framework:genindex>` -| :ref:`onap-dcaegen2 <onap-dcaegen2:genindex>` -| :ref:`onap-vnfsdk-model <onap-vnfsdk-model:genindex>` -| :ref:`onap-usecase-ui <onap-usecase-ui:genindex>` -| :ref:`onap-vid <onap-vid:genindex>` -| :ref:`onap-aaf-authz <onap-aaf-authz:genindex>` +| :ref:`onap-oom-offline-installer <onap-oom-offline-installer:master_index>` +| :ref:`onap-oom <onap-oom:master_index>` +| :ref:`onap-oparent-cia <onap-oparent-cia:master_index>` +| :ref:`onap-music-distributed-kv-store <onap-music-distributed-kv-store:master_index>` +| :ref:`onap-dmaap-dbcapi <onap-dmaap-dbcapi:master_index>` +| :ref:`onap-msb-swagger-sdk <onap-msb-swagger-sdk:master_index>` +| :ref:`onap-msb-java-sdk <onap-msb-java-sdk:master_index>` +| :ref:`onap-holmes-engine-management <onap-holmes-engine-management:master_index>` +| :ref:`onap-multicloud-azure <onap-multicloud-azure:master_index>` +| :ref:`onap-modeling-etsicatalog <onap-modeling-etsicatalog:master_index>` +| :ref:`onap-modeling-toscaparsers <onap-modeling-toscaparsers:master_index>` +| :ref:`onap-modeling-modelspec <onap-modeling-modelspec:master_index>` +| :ref:`onap-vnfrqts-requirements <onap-vnfrqts-requirements:master_index>` +| :ref:`onap-vnfrqts-guidelines <onap-vnfrqts-guidelines:master_index>` +| :ref:`onap-dmaap-messagerouter-messageservice <onap-dmaap-messagerouter-messageservice:master_index>` +| :ref:`onap-externalapi-nbi <onap-externalapi-nbi:master_index>` +| :ref:`onap-logging-analytics <onap-logging-analytics:master_index>` +| :ref:`onap-dmaap-buscontroller <onap-dmaap-buscontroller:master_index>` +| :ref:`onap-dmaap-datarouter <onap-dmaap-datarouter:master_index>` +| :ref:`onap-music <onap-music:master_index>` +| :ref:`onap-sdc-sdc-workflow-designer <onap-sdc-sdc-workflow-designer:master_index>` +| :ref:`onap-sdc-sdc-tosca <onap-sdc-sdc-tosca:master_index>` +| :ref:`onap-vvp-documentation <onap-vvp-documentation:master_index>` +| :ref:`onap-logging-analytics-pomba-pomba-audit-common <onap-logging-analytics-pomba-pomba-audit-common:master_index>` +| :ref:`onap-msb-apigateway <onap-msb-apigateway:master_index>` +| :ref:`onap-msb-discovery <onap-msb-discovery:master_index>` +| :ref:`onap-vnfrqts-testcases <onap-vnfrqts-testcases:master_index>` +| :ref:`onap-vnfrqts-usecases <onap-vnfrqts-usecases:master_index>` +| :ref:`onap-policy-parent <onap-policy-parent:master_index>` +| :ref:`onap-vfc-nfvo-lcm <onap-vfc-nfvo-lcm:master_index>` +| :ref:`onap-vfc-nfvo-driver-vnfm-svnfm <onap-vfc-nfvo-driver-vnfm-svnfm:master_index>` +| :ref:`onap-holmes-rule-management <onap-holmes-rule-management:master_index>` +| :ref:`onap-policy-engine <onap-policy-engine:master_index>` +| :ref:`onap-portal <onap-portal:master_index>` +| :ref:`onap-cli <onap-cli:master_index>` +| :ref:`onap-aaf-certservice <onap-aaf-certservice:master_index>` +| :ref:`onap-ccsdk-cds <onap-ccsdk-cds:master_index>` +| :ref:`onap-ccsdk-apps <onap-ccsdk-apps:master_index>` +| :ref:`onap-sdnc-oam <onap-sdnc-oam:master_index>` +| :ref:`onap-ccsdk-platform-plugins <onap-ccsdk-platform-plugins:master_index>` +| :ref:`onap-ccsdk-dashboard <onap-ccsdk-dashboard:master_index>` +| :ref:`onap-ccsdk-features <onap-ccsdk-features:master_index>` +| :ref:`onap-ccsdk-distribution <onap-ccsdk-distribution:master_index>` +| :ref:`onap-so-libs <onap-so-libs:master_index>` +| :ref:`onap-so <onap-so:master_index>` +| :ref:`onap-integration <onap-integration:master_index>` +| :ref:`onap-aai-aai-common <onap-aai-aai-common:master_index>` +| :ref:`onap-aaf-sms <onap-aaf-sms:master_index>` +| :ref:`onap-appc <onap-appc:master_index>` +| :ref:`onap-appc-deployment <onap-appc-deployment:master_index>` +| :ref:`onap-optf-cmso <onap-optf-cmso:master_index>` +| :ref:`onap-optf-osdf <onap-optf-osdf:master_index>` +| :ref:`onap-optf-has <onap-optf-has:master_index>` +| :ref:`onap-sdc-sdc-distribution-client <onap-sdc-sdc-distribution-client:master_index>` +| :ref:`onap-sdc-sdc-docker-base <onap-sdc-sdc-docker-base:master_index>` +| :ref:`onap-sdc <onap-sdc:master_index>` +| :ref:`onap-clamp <onap-clamp:master_index>` +| :ref:`onap-aai-event-client <onap-aai-event-client:master_index>` +| :ref:`onap-aai-sparky-be <onap-aai-sparky-be:master_index>` +| :ref:`onap-aai-esr-gui <onap-aai-esr-gui:master_index>` +| :ref:`onap-aai-esr-server <onap-aai-esr-server:master_index>` +| :ref:`onap-multicloud-k8s <onap-multicloud-k8s:master_index>` +| :ref:`onap-multicloud-framework <onap-multicloud-framework:master_index>` +| :ref:`onap-dcaegen2 <onap-dcaegen2:master_index>` +| :ref:`onap-vnfsdk-model <onap-vnfsdk-model:master_index>` +| :ref:`onap-usecase-ui <onap-usecase-ui:master_index>` +| :ref:`onap-vid <onap-vid:master_index>` +| :ref:`onap-aaf-authz <onap-aaf-authz:master_index>` 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:: diff --git a/docs/guides/onap-operator/onap-portal-admin/onap-portal-admin.rst b/docs/guides/onap-operator/onap-portal-admin/onap-portal-admin.rst index 81d42f6a7..73a32fa75 100644 --- a/docs/guides/onap-operator/onap-portal-admin/onap-portal-admin.rst +++ b/docs/guides/onap-operator/onap-portal-admin/onap-portal-admin.rst @@ -17,7 +17,7 @@ The Portal SDK for application developers includes bundled tools, technologies, and built-in capabilities such as services, APIs, and UI controls. Existing applications can migrate to the Portal with the provided APIs and libraries. See `ONAP Portal SDK -Documentation <http://onap.readthedocs.io/en/latest/submodules/portal.git/docs/tutorials/index.html>`__\. +:ref:`Documentation<onap-portal:master_index>`. Access ------ @@ -25,7 +25,7 @@ Access Access the ONAP Portal using Mozilla Firefox or Google Chrome(win/mac) at the provided URL. For example: `https://<hostname:port>/ONAPPORTAL/login.html`. -Access the ONAP portal via the 8989 LoadBalancer documented `here <https://onap.readthedocs.io/en/latest/submodules/oom.git/docs/oom_user_guide.html#accessing-the-onap-portal-using-oom-and-a-kubernetes-cluster>`__ +:ref:`Access the ONAP portal via the 8989 LoadBalancer documented `here<onap-oom:onap-on-kubernetes-with-rancher>` From the Portal, users access applications directly or by function using the `Manage menu`. @@ -60,7 +60,7 @@ Admin Tasks From the ONAP Portal, administrators: - access the same functionality accessible to users (see `ONAP Portal - for users <#PAGE_1018759>`__) + for users <onap-#PAGE_1018759>`__) - manage users and application admins diff --git a/docs/guides/onap-operator/platformoperations.rst b/docs/guides/onap-operator/platformoperations.rst index edde9aed8..520586e84 100644 --- a/docs/guides/onap-operator/platformoperations.rst +++ b/docs/guides/onap-operator/platformoperations.rst @@ -20,7 +20,7 @@ be found in: :maxdepth: 2 :titlesonly: - ../../submodules/oom.git/docs/oom_user_guide.rst +:ref:`oom_user_guide<onap-oom:oom_user_guide>` ONAP Testing and Monitoring --------------------------- @@ -38,7 +38,7 @@ functions :maxdepth: 2 :titlesonly: - RobotFramework <../../submodules/integration.git/docs/docs_robot.rst> +:ref:`RobotFramework<onap-integration:docs_robot>` **Interface Health can be checked via Consul:** @@ -61,9 +61,9 @@ functions graphically view the current health status of all of the ONAP components for which agents have been created - The Consul GUI can be accessed via: + The Consul GUI can be accessed via http AT - http://<kubernetes IP>:30270/ui/ + <kubernetes IP>:30270/ui/ **ONAP Log collection is provided by the Logging and Analytics Module:** @@ -71,7 +71,7 @@ functions :maxdepth: 2 :titlesonly: - Logging&Analytics <../../submodules/logging-analytics.git/docs/index.rst> +:ref:`Logging & Analytics <onap-logging-analytics:master_index>` ONAP Backup and Restore ----------------------- @@ -90,5 +90,5 @@ the MUSIC component: :maxdepth: 2 :titlesonly: - Multi-Site State Coordination <../../submodules/music.git/docs/index.rst> +:ref:`Multi-Site State Coordination<onap-music:master_index>` diff --git a/docs/guides/onap-operator/settingup/index.rst b/docs/guides/onap-operator/settingup/index.rst index f96388891..f24349b3e 100644 --- a/docs/guides/onap-operator/settingup/index.rst +++ b/docs/guides/onap-operator/settingup/index.rst @@ -50,7 +50,7 @@ Creation of Kubernetes cluster is described here: :maxdepth: 2 :titlesonly: - ../../../../submodules/oom.git/docs/oom_cloud_setup_guide.rst +:ref:`oom_cloud_setup_guide<onap-oom:oom_cloud_setup_guide>` ONAP installation is described here: @@ -58,8 +58,8 @@ ONAP installation is described here: :maxdepth: 2 :titlesonly: - ../../../../submodules/oom.git/docs/oom_quickstart_guide.rst - ../../../../submodules/oom.git/docs/oom_user_guide.rst +:ref:`oom_quickstart_guide<onap-oom:oom_quickstart_guide>` +:ref:`oom_user_guide<onap-oom:oom_user_guide>` Alternative way of offline ONAP installation is described here: @@ -67,7 +67,7 @@ Alternative way of offline ONAP installation is described here: :maxdepth: 2 :titlesonly: - ../../../../submodules/oom/offline-installer.git/docs/index.rst +:ref:`oom offline-installer<onap-oom-offline-installer:master_index>` .. note:: Prior to deployment of ONAP, there is no need to download manually any Docker container. diff --git a/docs/guides/onap-provider/index.rst b/docs/guides/onap-provider/index.rst index 94761744b..efea37aa3 100644 --- a/docs/guides/onap-provider/index.rst +++ b/docs/guides/onap-provider/index.rst @@ -14,9 +14,8 @@ set up an VNF or PNF for ONAP usage. .. toctree:: :maxdepth: 2 - ../../../submodules/vnfrqts/guidelines.git/docs/index.rst - ../../../submodules/vnfrqts/requirements.git/docs/index.rst - ../../../submodules/vnfrqts/testcases.git/docs/index.rst - ../../../submodules/vnfrqts/usecases.git/docs/index.rst - ../../../submodules/vnfrqts/requirements.git/docs/release-notes.rst - vnfvalidator.rst
\ No newline at end of file +:ref:`vnfrqts guidelines<onap-vnfrqts-guidelines:master_index>` +:ref:`vnfrqts requirements<onap-vnfrqts-requirements:master_index>` +:ref:`vnfrqts testcases<onap-vnfrqts-testcases:master_index>` +:ref:`vnfrqts usecases<onap-vnfrqts-usecases:master_index>` +:ref:`vnfrqts requirements docs release-notes<onap-vnfrqts-requirements:release_notes>` diff --git a/docs/guides/onap-provider/vnfvalidator.rst b/docs/guides/onap-provider/vnfvalidator.rst index 7cf322205..9a80e3e25 100644 --- a/docs/guides/onap-provider/vnfvalidator.rst +++ b/docs/guides/onap-provider/vnfvalidator.rst @@ -6,5 +6,6 @@ VNF Validation Documentation .. toctree:: :maxdepth: 2 - ../../../submodules/vvp/documentation.git/docs/index.rst - ../../../submodules/vvp/documentation.git/docs/release-notes.rst +:ref:`vvp documentation<onap-vvp-documentation:master_index>` + +:ref:`vvp documentation release-notes<onap-vvp-documentation:release_notes>` diff --git a/docs/guides/onap-user/design/control-loop/index.rst b/docs/guides/onap-user/design/control-loop/index.rst index a8e77007c..462069673 100644 --- a/docs/guides/onap-user/design/control-loop/index.rst +++ b/docs/guides/onap-user/design/control-loop/index.rst @@ -55,7 +55,8 @@ Design a Model is available on DCAE. **Prerequisites:** Create and test a VF -(see :ref:`VF Creation and Testing <user-guides-service-design>`). + +#TODO ADD A LINK TO VF Creation and Testing user-guides-service-design? #. Create and name a new model #. Associate a Service with the model @@ -264,7 +265,8 @@ With open loop control systems, the action(s) taken by the Policy do not affect the output of the system. For information about creating policy using the Policy Designer, -see :ref:`Policy Design <user-guides-service-design>`. + +#TODO ADD A LINK TO VF Creation and Testing user-guides-service-design? .. |image0| image:: media/DesignModel.png diff --git a/docs/guides/onap-user/design/index.rst b/docs/guides/onap-user/design/index.rst index ec7d67b6f..0d89bd0df 100644 --- a/docs/guides/onap-user/design/index.rst +++ b/docs/guides/onap-user/design/index.rst @@ -114,15 +114,15 @@ The follwing sections will focus on the different Design steps: VNF parameter resolution Design <./parameter_resolution/index.rst> - Policy Design <../../../submodules/policy/parent.git/docs/design/design.rst> +:ref:`Policy Design<onap-policy-parent:design-label>` - VNF LifeCycle Command templating <../../../submodules/appc.git/docs/APPC CDT Guide/APPC CDT Guide.rst> +:ref:`VNF LifeCycle Command templating<onap-appc:master_index>` - Workflow Design <../../../submodules/sdc.git/docs/workflow.rst> +:ref:`Workflow Design<onap-sdc:workflow>` - Control Loop Design <../../../submodules/sdc.git/docs/dcaedesigner.rst> +:ref:`Control Loop Design<onap-sdc:dcaedesigner>` - Control Loop Automation Management <../../../submodules/clamp.git/docs/index.rst> +:ref:`Control Loop Automation Management<onap-clamp:master_index>` diff --git a/docs/guides/onap-user/design/pre-onboarding/index.rst b/docs/guides/onap-user/design/pre-onboarding/index.rst index 796c4f340..26d801c47 100644 --- a/docs/guides/onap-user/design/pre-onboarding/index.rst +++ b/docs/guides/onap-user/design/pre-onboarding/index.rst @@ -32,7 +32,7 @@ These steps are performed outside SDC. onboarding. The requirements are found in the following document. -`Heat requirements <../../../../submodules/vnfrqts/requirements.git/docs/Chapter5/Heat/index.html>`_ +:ref:`Heat requirements<onap-vnfrqts-requirements:master_index>` #. Put the Heat, ENV, nested Heat, and other files used by get-file in templates in a directory on a host, which supports python. @@ -72,9 +72,9 @@ Validate xNF Package (VNF/PNF) VNF and PNF packages have to follow the requirements described in: -`VNF and PNF Modeling Requirements <../../../../submodules/vnfrqts/requirements.git/docs/Chapter5/index.html>`_ +:ref:``VNF and PNF Modeling Requirements<vnfrqts-requirements:master_index>` -`ONAP Management Requirements <../../../../submodules/vnfrqts/requirements.git/docs/Chapter7/index.html>`_ +:ref:``ONAP Management Requirements<vnfrqts-requirements:master_index>` For Validation of VNF and PNF packages the tools delivered by VNFSDK can be used: @@ -107,4 +107,4 @@ No VF functionality testing is performed at this stage. .. _generate-manifest.py: https://git.onap.org/sdc/tree/openecomp-be/tools/scripts/generate-manifest.py -.. _example-packages: https://git.onap.org/sdc/tree/test-apis-ci/sdc-api-tests/chef-repo/cookbooks/sdc-api-tests/files/default/Files
\ No newline at end of file +.. _example-packages: https://git.onap.org/sdc/tree/test-apis-ci/sdc-api-tests/chef-repo/cookbooks/sdc-api-tests/files/default/Files diff --git a/docs/guides/onap-user/index.rst b/docs/guides/onap-user/index.rst index f8ca1eb0b..dd40f7321 100644 --- a/docs/guides/onap-user/index.rst +++ b/docs/guides/onap-user/index.rst @@ -18,5 +18,6 @@ an instance of ONAP. instantiate/index.rst configure/index.rst onapcli.rst - Verified Use Cases <../../submodules/integration.git/docs/docs_usecases.rst> - Using ONAP Rest API with Postman <../../submodules/integration.git/docs/docs_postman.rst> +:ref:`Verified Use Cases<onap-integration:docs_usecases>` + +:ref:`Using ONAP Rest API with Postman<onap-integration:docs_postman>` diff --git a/docs/guides/onap-user/instantiate/instantiation/nbi/index.rst b/docs/guides/onap-user/instantiate/instantiation/nbi/index.rst index 96bbc3a8d..28ef5d965 100644 --- a/docs/guides/onap-user/instantiate/instantiation/nbi/index.rst +++ b/docs/guides/onap-user/instantiate/instantiation/nbi/index.rst @@ -16,7 +16,7 @@ Additional info in: :maxdepth: 1 :titlesonly: - NBI Guide <../../../../../submodules/externalapi/nbi.git/docs/offeredapis/offeredapis.rst> +:ref:`NBI Guide<onap-externalapi-nbi:offeredapis>` ONAP NBI will convert that request to ONAP SO request. diff --git a/docs/guides/onap-user/instantiate/instantiation/uui/index.rst b/docs/guides/onap-user/instantiate/instantiation/uui/index.rst index fa57be271..70d825e70 100644 --- a/docs/guides/onap-user/instantiate/instantiation/uui/index.rst +++ b/docs/guides/onap-user/instantiate/instantiation/uui/index.rst @@ -11,4 +11,4 @@ e2eServiceInstance mode via ONAP UUI Portal :maxdepth: 1 :titlesonly: - ../../../../../submodules/usecase-ui.git/docs/platform/installation/user-guide/index.rst +:ref:`usecase-ui docs platform installation user-guide<onap-usecase-ui:master_index>` diff --git a/docs/guides/onap-user/instantiate/instantiation/vid/index.rst b/docs/guides/onap-user/instantiate/instantiation/vid/index.rst index d6b082488..9b367f9cf 100644 --- a/docs/guides/onap-user/instantiate/instantiation/vid/index.rst +++ b/docs/guides/onap-user/instantiate/instantiation/vid/index.rst @@ -10,4 +10,4 @@ A La Carte mode Service Instantiation via ONAP VID Portal :maxdepth: 1 :titlesonly: - ../../../../../submodules/vid.git/docs/instantiate.rst +:ref:`vidgit docs instantiaterst<onap-vid:instantiate>` diff --git a/docs/guides/onap-user/onap-portal-user/onap-portal-user.rst b/docs/guides/onap-user/onap-portal-user/onap-portal-user.rst index 7ce2f3a08..8fd8854f4 100644 --- a/docs/guides/onap-user/onap-portal-user/onap-portal-user.rst +++ b/docs/guides/onap-user/onap-portal-user/onap-portal-user.rst @@ -16,8 +16,7 @@ manage applications and widgets, and manage user access. The Portal SDK for application developers includes bundled tools, technologies, and built-in capabilities such as services, APIs, and UI controls. Existing applications can migrate to the Portal with the -provided APIs and libraries. See `ONAP Portal SDK -Documentation <http://onap.readthedocs.io/en/latest/submodules/portal.git/docs/tutorials/index.html>`__\. +provided APIs and libraries. :ref:`ONAP Portal SDK Documentation<onap-portal:master_index>` Access ------ @@ -25,7 +24,7 @@ Access Access the ONAP Portal using Mozilla Firefox or Google Chrome(win/mac) at the provided URL. For example: `https://<hostname:port>/ONAPPORTAL/login.html`. -Access the ONAP portal via the 8989 LoadBalancer documented `here <https://onap.readthedocs.io/en/latest/submodules/oom.git/docs/oom_user_guide.html#accessing-the-onap-portal-using-oom-and-a-kubernetes-cluster>`__ +:ref:`Access the ONAP portal via the 8989 LoadBalancer <onap-oom:onap-on-kubernetes-with-rancher>` From the Portal, users access applications directly or by function using the `Manage menu`. diff --git a/docs/guides/onap-user/onapcli.rst b/docs/guides/onap-user/onapcli.rst index 6c13c2780..27c8087dc 100644 --- a/docs/guides/onap-user/onapcli.rst +++ b/docs/guides/onap-user/onapcli.rst @@ -7,5 +7,4 @@ ONAP CLI .. toctree:: :maxdepth: 2 - ../../../submodules/cli.git/docs/user_guide.rst - ../../../submodules/cli.git/docs/OCLIP.rst
\ No newline at end of file +:ref:`cligit docs user_guiderst<onap-cli:cli_user_guide>` diff --git a/docs/guides/onap-user/onapportal.rst b/docs/guides/onap-user/onapportal.rst index 8c1107bb4..205798ec3 100644 --- a/docs/guides/onap-user/onapportal.rst +++ b/docs/guides/onap-user/onapportal.rst @@ -18,7 +18,7 @@ and UI controls. Existing applications can migrate to the Portal with the provided APIs and libraries. See Portal SDK_. -.. _SDK: https://docs.onap.org/en/latest/submodules/portal.git/docs/tutorials/portal-sdk/index.html +:ref:`docs tutorials portal-sdk <onap-portal:master_index>` Access the ONAP Portal ---------------------- diff --git a/docs/release/index.rst b/docs/release/index.rst index 43e838957..62b48e290 100644 --- a/docs/release/index.rst +++ b/docs/release/index.rst @@ -52,7 +52,7 @@ Details about discovered and mitigated vulnerabilities are in ONAP has adopted the `CII Best Practice Badge Program <https://bestpractices.coreinfrastructure.org/en>`_. -- `Badging Requirements <https://github.com/coreinfrastructure/best-practices-badge#core-infrastructure-initiative-best-practices-badge>`_ +- `Badging Requirements <https://github.com/coreinfrastructure/best-practices-badge>`_ - `Badging Status for all ONAP projects <https://bestpractices.coreinfrastructure.org/en/projects?q=onap>`_ Project specific details are in the :ref:`release notes<doc-releaserepos>` for @@ -86,9 +86,7 @@ There are 2 ways to report a bug in ONAP. * If you don't know you are facing a bug or have a question, post your question into the `Ask question <https://wiki.onap.org/display/DW/questions/all>`_. You will need a Linux Foundation ID to login and post your question. - Get a Linux Foundation Identity using this `quick procedure <https://wiki.onap.org/display/DW/Joining+the+ONAP+Technical+Community#JoiningtheONAPTechnicalCommunity-WhereDoIStart?>`_. - -To properly report a bug in Jira, you may want to consider these `recommendations <https://wiki.onap.org/display/DW/Tracking+Issues+with+JIRA#TrackingIssueswithJIRA-RecommendationsforwrittingProperJIRAIssue>`_ to elaborate the issue you are facing. + Get a Linux Foundation Identity using this `quick procedure <https://docs.linuxfoundation.org/corporate-learners/creating-a-lf-id>`_. .. Include files referenced by link in the toctree as hidden diff --git a/docs/release/releaserepos.rst b/docs/release/releaserepos.rst index 000341792..05f9aa44e 100644 --- a/docs/release/releaserepos.rst +++ b/docs/release/releaserepos.rst @@ -10,38 +10,35 @@ Project Specific Release Notes .. toctree:: :maxdepth: 1 - :titlesonly: - - Active and Available Inventory<../submodules/aai/aai-common.git/docs/release-notes.rst> - Application Authorization Framework<../submodules/aaf/authz.git/docs/sections/release-notes.rst> - Application Controller<../submodules/appc.git/docs/release-notes.rst> - Common Controller Software Development Kit<../submodules/ccsdk/distribution.git/docs/release-notes.rst> - Command Line Interface<../submodules/cli.git/docs/release-notes.rst> - Closed Loop Automation Platform<../submodules/clamp.git/docs/release-notes.rst> - Data Collection, Analysis, and Events<../submodules/dcaegen2.git/docs/sections/release-notes.rst> - Documentation<../release-notes.rst> - DMAAP Message Router (MR) <../submodules/dmaap/messagerouter/messageservice.git/docs/release-notes/release-notes.rst> - DMAAP Dmaap Data Router (DR) <../submodules/dmaap/datarouter.git/docs/release-notes.rst> - DMAAP Dmaap Bus Controller (BC) <../submodules/dmaap/buscontroller.git/docs/release-notes/release-notes.rst> - External API / NorthBound Interface<../submodules/externalapi/nbi.git/docs/releasenotes/releasenotes.rst> - Holmes<../submodules/holmes/rule-management.git/docs/release-notes.rst> - Integration<../submodules/integration.git/docs/release-notes.rst> - Logging Analytics<../submodules/logging-analytics.git/docs/release-notes.rst> - Modeling/etsicatalog<../submodules/modeling/etsicatalog.git/docs/release-notes.rst> - Micro Services Bus<../submodules/msb/apigateway.git/docs/release-notes.rst> - MultiVIM Cloud<../submodules/multicloud/framework.git/docs/Release Notes.rst> - Music<../submodules/music.git/docs/release-notes.rst> - ONAP Operations Manager<../submodules/oom.git/docs/release-notes.rst> - Optimization Framework<../submodules/optf/osdf.git/docs/sections/release-notes.rst> - Policy Framework<../submodules/policy/parent.git/docs/release-notes.rst> - Portal Platform<../submodules/portal.git/docs/release-notes.rst> - Service Design & Creation<../submodules/sdc.git/docs/release-notes.rst> - Service Orchestration<../submodules/so.git/docs/release-notes.rst> - Software Defined Network Controller<../submodules/sdnc/oam.git/docs/release-notes.rst> - Use Case User Interface<../submodules/usecase-ui.git/docs/release-notes.rst> - Virtual Function Controller<../submodules/vfc/nfvo/lcm.git/docs/release-notes.rst> - Virtual Infrastructure Deployment<../submodules/vid.git/docs/release-notes.rst> - VNF Requirements<../submodules/vnfrqts/requirements.git/docs/release-notes.rst> - VNF Software Development Kit<../submodules/vnfsdk/model.git/docs/release-notes.rst> - VNF Validation Project<../submodules/vvp/documentation.git/docs/release-notes.rst> +| :ref:`Active and Available Inventory<onap-aai-aai-common:release_notes>` +| :ref:`Application Authorization Framework<onap-aaf-authz:release_notes>` +| :ref:`Application Controller<onap-appc:release_notes>` +| :ref:`Common Controller Software Development Kit<onap-ccsdk-distribution:release_notes>` +| :ref:`Command Line Interface<onap-cli:release_notes>` +| :ref:`Closed Loop Automation Platform<onap-clamp:release_notes>` +| :ref:`Data Collection Analysis and Events<onap-dcaegen2:release_notes>` +| :ref:`DMAAP Message Router (MR)<onap-dmaap-messagerouter-messageservice:release_notes>` +| :ref:`DMAAP Dmaap Data Router (DR)<onap-dmaap-datarouter:release_notes>` +| :ref:`DMAAP Dmaap Bus Controller (BC)<onap-dmaap-buscontroller:release_notes>` +| :ref:`External API NorthBound Interface<onap-externalapi-nbi:release_notes>` +| :ref:`Holmes<onap-holmes-rule-management:release_notes>` +| :ref:`Integration<onap-integration:release_notes>` +| :ref:`Logging Analytics<onap-logging-analytics:release_notes>` +| :ref:`Modeling etsicatalog<onap-modeling-etsicatalog:release_notes>` +| :ref:`Micro Services Bus<onap-msb-apigateway:release_notes>` +| :ref:`Music<onap-music:release_notes>` +| :ref:`MultiVIM Cloud <onap-multicloud-framework:master_index>` +| :ref:`ONAP Operations Manager<onap-oom:release_notes>` +| :ref:`Optimization Framework<onap-optf-osdf:release_notes>` +| :ref:`Policy Framework<onap-policy-parent:release_notes>` +| :ref:`Portal Platform<onap-portal:release_notes>` +| :ref:`Service Design & Creation<onap-sdc:release_notes>` +| :ref:`Service Orchestration<onap-so:release_notes>` +| :ref:`Software Defined Network Controller<onap-sdnc-oam:release_notes>` +| :ref:`Use Case User Interface<onap-usecase-ui:release_notes>` +| :ref:`Virtual Function Controller<onap-vfc-nfvo-lcm:release_notes>` +| :ref:`Virtual Infrastructure Deployment<onap-vid:release_notes>` +| :ref:`VNF Requirements<onap-vnfrqts-requirements:release_notes>` +| :ref:`VNF Software Development Kit<onap-vnfsdk-model:release_notes>` +| :ref:`VNF Validation Project<onap-vvp-documentation:release_notes>` diff --git a/docs/release/repolist.rst b/docs/release/repolist.rst deleted file mode 100644 index cc068acf1..000000000 --- a/docs/release/repolist.rst +++ /dev/null @@ -1,64 +0,0 @@ -.. 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. - - -.. index:: Projects Providing Documentation - -.. _doc-repolist: - -Project/Components ------------------- -.. Already referenced in other sections of doc project - aaf/authz <../submodules/aaf/authz.git/docs/index> - AAI - Active & Available Inventory <../submodules/aai/aai-common.git/docs/index> - AAI External System Registration Server <../submodules/aai/esr-server.git/docs/index> - AAI External System Registration UI <../submodules/aai/esr-gui.git/docs/index> - AAI Sparky Inventory UI <../submodules/aai/sparky-be.git/docs/index> - CCSDK Dashboard <../submodules/ccsdk/dashboard.git/docs/index> - ccsdk/distribution <../submodules/ccsdk/distribution.git/docs/index> - HOLMES - Alarm Correlation and Analysis <../submodules/holmes/engine-management.git/docs/index> - HOLMES - Architecuture and APIs <../submodules/holmes/rule-management.git/docs/index> - logging-analytics <../submodules/logging-analytics.git/docs/index> - modeling/toscaparsers <../submodules/modeling/toscaparsers.git/docs/index> - modeling/etsicatalog <../submodules/modeling/etsicatalog.git/docs/index> - MSB - Microservice Bus <../submodules/msb/apigateway.git/docs/index> - msb/swagger-sdk <../submodules/msb/swagger-sdk.git/docs/index> - MultiCloud Framework <../submodules/multicloud/framework.git/docs/index> - music <../submodules/music.git/docs/index> - ONAP Operations Manager <../submodules/oom.git/docs/index> - optf/osdf <../submodules/optf/osdf.git/docs/index> - sdc/sdc-workflow-designer <../submodules/sdc/sdc-workflow-designer.git/docs/index> - sdnc/oam <../submodules/sdnc/oam.git/docs/index> - Service Design and Creation <../submodules/sdc.git/docs/index> - Service Orchestrator <../submodules/so.git/docs/index> - so/libs <../submodules/so/libs.git/docs/index> - ../submodules/appc/deployment.git/docs/index - ../submodules/appc.git/docs/index - ../submodules/clamp.git/docs/index - ../submodules/cli.git/docs/index - ../submodules/dcaegen2.git/docs/index - ../submodules/dmaap/messagerouter/messageservice.git/docs/index - ../submodules/modeling/modelspec.git/docs/index - ../submodules/optf/has.git/docs/index - ../submodules/policy/engine.git/docs/index - ../submodules/portal.git/docs/index - ../submodules/vnfrqts/guidelines.git/docs/index - ../submodules/vnfrqts/requirements.git/docs/index - Use Case User Interface <../submodules/usecase-ui.git/docs/index> - VFC - Virtual Function Controller <../submodules/vfc/nfvo/lcm.git/docs/index> - VID - Virtual Infrastructure Deployment <../submodules/vid.git/docs/index> - VNF Software Development Kit <../submodules/vnfsdk/model.git/docs/index> - vvp/documentation <../submodules/vvp/documentation.git/docs/index> - externalapi/nbi <../submodules/externalapi/nbi.git/docs/index> - vnfrqts/testcases <../submodules/vnfrqts/testcases.git/docs/index> - vnfrqts/usecases <../submodules/vnfrqts/usecases.git/docs/index> - aai/event-client <../submodules/aai/event-client.git/docs/index> - CCSDK Orchestrator Plugins <../submodules/ccsdk/platform/plugins.git/docs/index> - Secret Management Service <../submodules/aaf/sms.git/docs/index> - dmaap/datarouter <../submodules/dmaap/datarouter.git/docs/index> - dmaap/dbcapi <../submodules/dmaap/dbcapi.git/docs/index> - music/distributed-kv-store <../submodules/music/distributed-kv-store.git/docs/index> - osa <../submodules/osa.git/docs/index> - - aaf/certservice <../submodules/aaf/certservice.git/docs/index> |