diff options
Diffstat (limited to 'docs/guides/onap-user')
10 files changed, 23 insertions, 22 deletions
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 ---------------------- |