diff options
Diffstat (limited to 'docs/guides')
| -rw-r--r-- | docs/guides/onap-developer/apiref/index.rst | 3 | ||||
| -rw-r--r-- | docs/guides/onap-developer/architecture/references.rst | 50 | ||||
| -rw-r--r-- | docs/guides/onap-developer/how-to-use-docs/include-documentation.rst | 6 | ||||
| -rw-r--r-- | docs/guides/onap-developer/settingup/components.rst | 7 | ||||
| -rw-r--r-- | docs/guides/onap-user/index.rst | 1 | ||||
| -rw-r--r-- | docs/guides/onap-user/platformoperations.rst | 15 |
6 files changed, 28 insertions, 54 deletions
diff --git a/docs/guides/onap-developer/apiref/index.rst b/docs/guides/onap-developer/apiref/index.rst index cf8bb1e25..01049c180 100644 --- a/docs/guides/onap-developer/apiref/index.rst +++ b/docs/guides/onap-developer/apiref/index.rst @@ -22,7 +22,7 @@ User Interfaces CLAMP - Closed Loop Automation Platform <../../../submodules/clamp.git/docs/index.rst> SDC - Service Design and Creation <../../../submodules/sdc.git/docs/offeredapis.rst> - VID - Virtual Infrastructure Deployment <../../../submodules/vid.git/docs/docs-offeredapis.rst> + VID - Virtual Infrastructure Deployment <../../../submodules/vid.git/docs/offeredapis.rst> Platform Components ------------------- @@ -35,7 +35,6 @@ Platform Components 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/engine.git/docs/platform/offeredapis.rst> - SDNC - Software Defined Network Controller <../../../submodules/sdnc/northbound.git/docs/offeredapis.rst> SO - Service Orchestration <../../../submodules/so.git/docs/offered_consumed_apis.rst> VFC - Virtual Function Controller <../../../submodules/vfc/nfvo/lcm.git/docs/platform/APIs/index.rst> NBI - NorthBound API <../../../submodules/externalapi/nbi.git/docs/offeredapis/index.rst> diff --git a/docs/guides/onap-developer/architecture/references.rst b/docs/guides/onap-developer/architecture/references.rst index 7d8334d31..6a72a398d 100644 --- a/docs/guides/onap-developer/architecture/references.rst +++ b/docs/guides/onap-developer/architecture/references.rst @@ -31,15 +31,8 @@ User Interfaces CLAMP - Closed Loop Automation Platform <../../../submodules/clamp.git/docs/architecture.rst> CLI - Command Line Interface <../../../submodules/cli.git/docs/architecture.rst> SDC - Service Design and Creation <../../../submodules/sdc.git/docs/architecture.rst> - ../../../submodules/sdc/jtosca.git/docs/architecture.rst - ../../../submodules/sdc/sdc-distribution-client.git/docs/architecture.rst - ../../../submodules/sdc/sdc-docker-base.git/docs/architecture.rst - ../../../submodules/sdc/sdc-titan-cassandra.git/docs/architecture.rst - ../../../submodules/sdc/sdc-tosca.git/docs/architecture.rst - ../../../submodules/sdc/sdc-workflow-designer.git/docs/architecture.rst - ../../../submodules/usecase-ui.git/docs/architecture.rst - ../../../submodules/vid/asdcclient.git/docs/architecture.rst - VID - Virtual Infrastructure Deployment <../../../submodules/vid.git/docs/intro/index> + ../../../submodules/usecase-ui.git/docs/platform/architecture.rst + VID - Virtual Infrastructure Deployment <../../../submodules/vid.git/docs/architecture.rst> Platform Components ------------------- @@ -48,24 +41,10 @@ Platform Components :maxdepth: 1 :titlesonly: - ../../../submodules/appc/deployment.git/docs/architecture.rst - ../../../submodules/appc.git/docs/architecture.rst DCAE - Data Collection Analytics and Events <../../../submodules/dcaegen2.git/docs/sections/architecture.rst> - ../../../submodules/holmes/engine-management.git/docs/architecture.rst Holmes <../../../submodules/holmes/rule-management.git/docs/platform/architecture.rst> - ../../../submodules/policy/engine.git/docs/architecture.rst - ../../../submodules/sdnc/adaptors.git/docs/architecture.rst - ../../../submodules/sdnc/architecture.git/docs/architecture.rst - ../../../submodules/sdnc/core.git/docs/architecture.rst - ../../../submodules/sdnc/features.git/docs/architecture.rst - SDN Northbound <../../../submodules/sdnc/northbound.git/docs/architecture.rst SDN Controller OAM <../../../submodules/sdnc/oam.git/docs/architecture.rst> - ../../../submodules/sdnc/parent.git/docs/architecture.rst - ../../../submodules/sdnc/plugins.git/docs/architecture.rst - ../../../submodules/so/libs.git/docs/architecture.rst ../../../submodules/so.git/docs/architecture.rst - ../../../submodules/vfc/lcm.git/docs/architecture.rst - ../../../submodules/vfc/nfvo/lcm.git/docs/architecture.rst Common Services --------------- @@ -77,13 +56,7 @@ Common Services 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> - ../../../submodules/aai/sparky-be.git/docs/architecture.rst - ../../../submodules/dmaap/messagerouter/messageservice.git/docs/architecture.rst MSB - Microservices Bus <../../../submodules/msb/apigateway.git/docs/platform/architecture.rst> - ../../../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 SDKs ---- @@ -92,23 +65,8 @@ SDKs :maxdepth: 1 :titlesonly: - ../../../submodules/ccsdk/distribution.git/docs/architecture.rst - ../../../submodules/ccsdk/dashboard.git/docs/architecture.rst - ../../../submodules/ccsdk/platform/blueprints.git/docs/architecture.rst - ../../../submodules/ccsdk/platform/nbapi.git/docs/architecture.rst - ../../../submodules/ccsdk/storage/esaas.git/docs/architecture.rst - ../../../submodules/ccsdk/storage/pgaas.git/docs/architecture.rst - ../../../submodules/ccsdk/utils.git/docs/architecture.rst Portal <../../../submodules/portal.git/docs/tutorials/portal-sdk/architecture.rst> - ../../../submodules/vnfsdk/model.git/docs/architecture.rst -.. CCSDK documentation consolidated under the above distribution repo - ../../../submodules/ccsdk/platform/plugins.git/docs/architecture.rst - ../../../submodules/ccsdk/parent.git/docs/architecture.rst - CCSDK SLI Adaptors <../../../submodules/ccsdk/sli/adaptors.git/docs/architecture.rst> - CCSDK SLI Service Logic Intrepreter <../../../submodules/ccsdk/sli/core.git/docs/architecture.rst> - CCSDK SLI Northbound Interface <../../../submodules/ccsdk/sli/northbound.git/docs/architecture.rst> - CCSDK SLI Plugins <../../../submodules/ccsdk/sli/plugins.git/docs/architecture.rst> VNFs ---- @@ -126,7 +84,3 @@ Other :maxdepth: 1 :titlesonly: - ../../../submodules/integration.git/docs/architecture.rst - ../../../submodules/optf/has.git/docs/architecture.rst - ../../../submodules/vnfrqts/guidelines.git/docs/architecture.rst - ../../../submodules/vnfrqts/requirements.git/docs/architecture.rst 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 4e76f6149..fb32a3e36 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 @@ -43,9 +43,13 @@ Setup doc project These steps are performed only once for the doc project and include: (1) creating in the doc repository an initial: + - sphinx master document index + - a directory structure aligned with the document structure + - tests performed in jenkins verify jobs + - sphinx configuration (2) establishing an account at readthedocs connected with the doc @@ -217,7 +221,9 @@ Here are some conventions about GIT branches: The day of the release, the repository owner will create a new branch to fix the code and documentation. This will represent the 'stable' code of the release. In this context: + - NEVER push a new feature on a stable branch + - Only bug correction are authorized on a stable branch using cherry pick method .. image:: git_branches.png diff --git a/docs/guides/onap-developer/settingup/components.rst b/docs/guides/onap-developer/settingup/components.rst index 047038d0f..fe18e57da 100644 --- a/docs/guides/onap-developer/settingup/components.rst +++ b/docs/guides/onap-developer/settingup/components.rst @@ -22,7 +22,6 @@ User Interfaces SDC - Service Design and Creation <../../../submodules/sdc.git/docs/installation.rst> Use-Case UI <../../../submodules/usecase-ui.git/docs/platform/installation.rst> VID - Virtual Infrastructure Deployment <../../../submodules/vid.git/docs/installation.rst> - SDNC - Software-Defined Networks Controller <../../../submodules/sdnc/oam.git/docs/installation.rst> Platform Components ------------------- @@ -31,11 +30,11 @@ Platform Components :maxdepth: 1 :titlesonly: - APPC - Application Controller <../../../submodules/appc.git/docs/APPC%20Deployment%20Guidelines/APPC%20Deployment%20Guidelines.rst> + APPC - Application Controller <../../../submodules/appc/deployment.git/docs/APPC%20Deployment%20Guidelines/APPC%20Deployment%20Guidelines.rst> DCAE - Data Collection, Analytics, and Events <../../../submodules/dcaegen2.git/docs/sections/installation.rst> - Holmes - Alarm Correlation <../../../submodules/holmes.git/docs/platform/installation.rst> + Holmes - Alarm Correlation <../../../submodules/holmes/rule-management.git/docs/platform/installation.rst> Policy <../../../submodules/policy/engine.git/docs/platform/installation.rst> - SDNC - Software Defined Network Controller <../../../submodules/sdnc/northbound.git/docs/installation.rst> + SDNC - Software-Defined Networks Controller <../../../submodules/sdnc/oam.git/docs/installation.rst> SO - Service Orchestration <../../../submodules/so.git/docs/Install_Configure_SO.rst> VFC - Virtual Function Controller <../../../submodules/vfc/nfvo/lcm.git/docs/platform/installation.rst> diff --git a/docs/guides/onap-user/index.rst b/docs/guides/onap-user/index.rst index 7b0420df6..27338d685 100644 --- a/docs/guides/onap-user/index.rst +++ b/docs/guides/onap-user/index.rst @@ -14,6 +14,7 @@ an instance of ONAP. :maxdepth: 1 platformadmin.rst + platformoperations.rst servicedesigner.rst servicecreator.rst vnfprovider.rst diff --git a/docs/guides/onap-user/platformoperations.rst b/docs/guides/onap-user/platformoperations.rst new file mode 100644 index 000000000..02daadd0f --- /dev/null +++ b/docs/guides/onap-user/platformoperations.rst @@ -0,0 +1,15 @@ +.. 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. + + +Platform Operations +=================== + +.. toctree:: + :maxdepth: 1 + :titlesonly: + + ../../../submodules/oom.git/docs/oom_cloud_setup_guide.rst + ../../../submodules/oom.git/docs/oom_quickstart_guide.rst + ../../../submodules/oom.git/docs/oom_user_guide.rst |