X-Git-Url: https://gerrit.onap.org/r/gitweb?a=blobdiff_plain;f=docs%2Fguides%2Fonap-developer%2Fdeveloping%2Findex.rst;h=14c9a85f8289e11127ac2c7cd4a5f6f1b5afbf84;hb=23fddddd50b38f393e9decbab6f7f26f71dbc02c;hp=c6528f12c2f6e9d539eaae4072272439e89dcbd4;hpb=73f564907c0d1b17cf87d377c33524a8ec33c2c4;p=doc.git

diff --git a/docs/guides/onap-developer/developing/index.rst b/docs/guides/onap-developer/developing/index.rst
index c6528f12c..14c9a85f8 100644
--- a/docs/guides/onap-developer/developing/index.rst
+++ b/docs/guides/onap-developer/developing/index.rst
@@ -1,4 +1,5 @@
-.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. 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.
 
@@ -6,284 +7,418 @@
 
 .. _doc_onap-developer_guide_projects:
 
-Developing ONAP
-===============
-Additional developer level detail is provided for each project below.
-
-Active and Available Inventory
+ONAP components and functionalities
+===================================
+Here you will find the detailed documentation of projects,
+ONAP components and functionalities
+
+Project - ONAP Integration
+--------------------------
+
+.. list-table::
+   :widths: 20 80
+   :header-rows: 1
+
+   * - Document
+     - Description
+   * - :ref:`Integration<onap-integration:master_index>`
+     - ONAP Integration Project Documentation
+
+Project - ONAP Modeling
+-----------------------
+
+.. list-table::
+   :widths: 20 80
+   :header-rows: 1
+
+   * - Document
+     - Description
+   * - :ref:`Model<onap-modeling-modelspec:master_index>`
+     - ONAP Model Specification
+   * - :ref:`ETSI Catalog<onap-modeling-etsicatalog:master_index>`
+     - ONAP ETSI Runtime Catalog Documentation
+
+
+AAF - Application Authorization Framework
+-----------------------------------------
+
+.. list-table::
+   :widths: 20 80
+   :header-rows: 1
+
+   * - Document
+     - Description
+   * - :ref:`AAF<onap-aaf-authz:master_index>`
+     - AAF Architecture, APIs and Guides
+   * - :ref:`Secret Management Service<onap-aaf-sms:master_index>`
+     - Secret Management Service Architecture and API
+
+AAI - Active and Available Inventory
+------------------------------------
+
+.. list-table::
+   :widths: 20 80
+   :header-rows: 1
+
+   * - Document
+     - Description
+   * - :ref:`AAI<onap-aai-aai-common:master_index>`
+     - AAI Architecture, APIs and Guides
+   * - :ref:`ESR<onap-aai-esr-gui:master_index>`
+     - External System Registry GUI Documentation (to be removed ?)
+   * - :ref:`ESR<onap-aai-esr-server:master_index>`
+     - External System Registry Server Documentation (to be removed ?)
+   * - :ref:`AAI Inventory UI<onap-aai-sparky-be:master_index>`
+     - Sparky - AAI Inventory UI Documentation (to be removed ?)
+   * - :ref:`AAI Event Client<onap-aai-event-client:master_index>`
+     - AAI Event Client Documentation (to be removed ?)
+
+APPC - Application Controller
+-----------------------------
+
+.. list-table::
+   :widths: 20 80
+   :header-rows: 1
+
+   * - Document
+     - Description
+   * - :ref:`APPC<onap-appc:master_index>`
+     - APPC Architecture, APIs and Guides
+   * - :ref:`APPC Deployment<onap-appc-deployment:master_index>`
+     - APPC Deployment Documentation
+
+CCSDK - Common Controller Software Development Kit
+--------------------------------------------------
+
+.. list-table::
+   :widths: 20 80
+   :header-rows: 1
+
+   * - Document
+     - Description
+   * - :ref:`Distribution<onap-ccsdk-distribution:master_index>`
+     - TOSCA Orchestration Plugin, Directed Graph Support
+   * - :ref:`Dashboard<onap-ccsdk-dashboard:master_index>`
+     - Common Controller Dashboard (To be removed ?)
+   * - :ref:`Platform Plugins<onap-ccsdk-platform-plugins:master_index>`
+     - Platform Plugins (To be removed ?)
+   * - :ref:`APPS<onap-ccsdk-apps:master_index>`
+     - Apps optside ODL (To be removed ?)
+
+CDS - Controller Design Studio
 ------------------------------
 
-.. toctree::
-   :maxdepth: 2
-   :titlesonly:
-
-   ../../../submodules/aai/aai-common.git/docs/index
-   AAI-esr-gui <../../../submodules/aai/esr-gui.git/docs/index>
-   ../../../submodules/aai/esr-server.git/docs/index
-   ../../../submodules/aai/sparky-be.git/docs/index
-
-
-Application Controller
-----------------------
-
-.. toctree::
-   :maxdepth: 2
-   :titlesonly:
-
-   ../../../submodules/appc/deployment.git/docs/index
-   ../../../submodules/appc.git/docs/index
-
-Closed Loop Automation Platform
--------------------------------
-
-.. toctree::
-   :maxdepth: 2
-   :titlesonly:
-
-   ../../../submodules/clamp.git/docs/index
-
-Common Controller Software Development Kit
-------------------------------------------
-
-.. toctree::
-   :maxdepth: 2
-   :titlesonly:
-
-   ../../../submodules/ccsdk/distribution.git/docs/index
-   ../../../submodules/ccsdk/dashboard.git/docs/index
-
-.. Being consolidated in ccsdk distribution
-   ../../../submodules/ccsdk/platform/blueprints.git/docs/index
-   ../../../submodules/ccsdk/platform/nbapi.git/docs/index
-   ../../../submodules/ccsdk/storage/esaas.git/docs/index
-   ../../../submodules/ccsdk/storage/pgaas.git/docs/index
-   ../../../submodules/ccsdk/utils.git/docs/index
-   ../../../submodules/ccsdk/parent.git/docs/index
-   ../../../submodules/ccsdk/platform/plugins.git/docs/index
-   ../../../submodules/ccsdk/sli/adaptors.git/docs/index
-   ../../../submodules/ccsdk/sli/core.git/docs/index
-   ../../../submodules/ccsdk/sli/northbound.git/docs/index
-   ../../../submodules/ccsdk/sli/plugins.git/docs/index
-
-Data Collection, Analysis, and Events
--------------------------------------
-
-.. toctree::
-   :maxdepth: 2
-   :titlesonly:
-
-   ../../../submodules/dcaegen2.git/docs/index
-
-Data Management as a Platform Message Router
---------------------------------------------
-
-.. toctree::
-   :maxdepth: 2
-   :titlesonly:
+.. list-table::
+   :widths: 20 80
+   :header-rows: 1
 
-   ../../../submodules/dmaap/messagerouter/messageservice.git/docs/index
+   * - Document
+     - Description
+   * - :ref:`CDS<onap-ccsdk-cds:master_index>`
+     - Controller Design Studio Architecture and Guides (part of CCSDK)
 
-Documentation
--------------
+CLAMP - Control Loop Automation Management Platform
+---------------------------------------------------
 
-.. toctree::
-   :maxdepth: 2
-   :titlesonly:
+.. list-table::
+   :widths: 20 80
+   :header-rows: 1
 
-   ../how-to-use-docs/index.rst
+   * - Document
+     - Description
+   * - :ref:`CLAMP <onap-clamp:master_index>`
+     - CLAMP Architecture and Guides
 
+CLI - Command Line Interface
+----------------------------
 
-Holmes
-------
+.. list-table::
+   :widths: 20 80
+   :header-rows: 1
 
-.. toctree::
-   :maxdepth: 2
-   :titlesonly:
+   * - Document
+     - Description
+   * - :ref:`CLI <onap-cli:master_index>`
+     - CLI Documentation
 
-   Alarm Correlation and Analysis <../../../submodules/holmes/engine-management.git/docs/index>
-   Architecture and APIs <../../../submodules/holmes/rule-management.git/docs/index>
+DCAE - Data Collection, Analysis and Events
+-------------------------------------------
 
-Integration
------------
+.. list-table::
+   :widths: 20 80
+   :header-rows: 1
 
-.. toctree::
-   :maxdepth: 2
-   :titlesonly:
+   * - Document
+     - Description
+   * - :ref:`DCAE<onap-dcaegen2:master_index>`
+     - DCAE Architecture and Guides
 
-   ../../../submodules/integration.git/docs/index
+DMAAP - Data Management as a Platform
+-------------------------------------
 
-Logging Enhancements Project
-----------------------------
+.. list-table::
+   :widths: 20 80
+   :header-rows: 1
+
+   * - Document
+     - Description
+   * - :ref:`Bus Controller<onap-dmaap-buscontroller:master_index>`
+     - Bus Controller Documentation
+   * - :ref:`Bus Controller API<onap-dmaap-dbcapi:master_index>`
+     - Bus Controller API Documentation
+   * - :ref:`Data Router<onap-dmaap-datarouter:master_index>`
+     - Data Router Documentation
+   * - :ref:`Message Router<onap-dmaap-messagerouter-messageservice:master_index>`
+     - Message Router Documentation
+
+EXTAPI - External API Framework/NBI
+-----------------------------------
 
-.. toctree::
-   :maxdepth: 2
-   :titlesonly:
+.. list-table::
+   :widths: 20 80
+   :header-rows: 1
 
-   ../../../submodules/logging-analytics.git/docs/index
+   * - Document
+     - Description
+   * - :ref:`EXTAPI<onap-externalapi-nbi:master_index>`
+     - External API Framework Documentation
 
-Micro Services Bus
-------------------
+HOLMES - Holmes Alarm Correlation and Analysis
+----------------------------------------------
 
-.. toctree::
-   :maxdepth: 2
-   :titlesonly:
+.. list-table::
+   :widths: 20 80
+   :header-rows: 1
 
-   ../../../submodules/msb/apigateway.git/docs/index
-   ../../../submodules/msb/swagger-sdk.git/docs/index
+   * - Document
+     - Description
+   * - :ref:`HOLMES<onap-holmes-rule-management:master_index>`
+     - HOLMES Architecture and APIs
+   * - :ref:`Engine Management<onap-holmes-engine-management:master_index>`
+     - HOLMES Engine Management Documentation
 
-.. Empty folders in this release
-   ../../../submodules/msb/discovery.git/docs/index
-   ../../../submodules/msb/java-sdk.git/docs/index
+LOGGING - Centralized Logging
+-----------------------------
 
+.. list-table::
+   :widths: 20 80
+   :header-rows: 1
 
-Modeling
---------
+   * - Document
+     - Description
+   * - :ref:`Logging<onap-logging-analytics:master_index>`
+     - ONAP Centralized Logging Documentation (to be deleted ?)
 
-.. toctree::
-   :maxdepth: 2
-   :titlesonly:
+MSB - Microservices Bus
+-----------------------
 
-   ../../../submodules/modeling/modelspec.git/docs/index
-   ../../../submodules/modeling/toscaparsers.git/docs/index
+.. list-table::
+   :widths: 20 80
+   :header-rows: 1
 
-MultiVIM Cloud
---------------
+   * - Document
+     - Description
+   * - :ref:`MSB<onap-msb-apigateway:master_index>`
+     - Microservices Bus Documentation
 
-.. toctree::
-   :maxdepth: 2
-   :titlesonly:
+MULTICLOUD - MultiCloud Framework
+---------------------------------
 
-   ../../../submodules/multicloud/framework.git/docs/index
+.. list-table::
+   :widths: 20 80
+   :header-rows: 1
 
+   * - Document
+     - Description
+   * - :ref:`MULTICLOUD<onap-multicloud-framework:master_index>`
+     - MultiCloud Framework Architecture and Guides
 
-ONAP Command Line Interface
----------------------------
+MUSIC - ONAP Multi-Site Integration
+-----------------------------------
 
-.. toctree::
-   :maxdepth: 2
-   :titlesonly:
+.. list-table::
+   :widths: 20 80
+   :header-rows: 1
 
-   ../../../submodules/cli.git/docs/index
+   * - Document
+     - Description
+   * - :ref:`MUSIC<onap-music:master_index>`
+     - MUSIC Architecture and Guides (To be deleted ?)
+   * - :ref:`Distributed KV Store<onap-music:master_index>`
+     - MUSIC Distribute KV Store Documents (To be deleted ?)
 
-ONAP Operations Manager (experimental)
---------------------------------------
+OOF - Optimization Framework
+----------------------------
 
-.. toctree::
-   :maxdepth: 2
-   :titlesonly:
+.. list-table::
+   :widths: 20 80
+   :header-rows: 1
+
+   * - Document
+     - Description
+   * - :ref:`Homing and Allocation<onap-optf-has:master_index>`
+     - ONAP policy-driven placement optimizing service documentation
+   * - :ref:`Optimization Service Design Framework<onap-optf-osdf:master_index>`
+     - Optimization Service Design Framework documentation
+   * - :ref:`Change Management Schedule Optimization<onap-optf-cmso:master_index>`
+     - Change Management Schedule Optimization documentation
+
+OOM - ONAP Operations Manager
+-----------------------------
+
+.. list-table::
+   :widths: 20 80
+   :header-rows: 1
+
+   * - Document
+     - Description
+   * - :ref:`OOM<onap-oom:master_index>`
+     - ONAP Operations Manager Documentation
+   * - :ref:`OOM Certification Service<onap-oom-certservice:master_index>`
+     - ONAP CMPv2 certification support
+
+ORAN - Open-RAN Support in ONAP
+-------------------------------
 
-   ../../../submodules/oom.git/docs/index
+.. list-table::
+   :widths: 20 80
+   :header-rows: 1
 
-ONAP Use Case User Interface
-----------------------------
+   * - Document
+     - Description
+   * - :ref:`ORAN<onap-ccsdk-oran:master_index>`
+     - O-RAN Support in ONAP (part of CCSDK)
 
-.. toctree::
-   :maxdepth: 2
-   :titlesonly:
-
-   ../../../submodules/usecase-ui.git/docs/index
+POLICY - Policy Framework
+-------------------------
 
-Policy Framework
-----------------
+.. list-table::
+   :widths: 20 80
+   :header-rows: 1
 
-.. toctree::
-   :maxdepth: 2
-   :titlesonly:
+   * - Document
+     - Description
+   * - :ref:`Policy<onap-policy-parent:master_index>`
+     - Policy Framework Documentation
 
-   ../../../submodules/policy/engine.git/docs/index
+PORTAL - Portal Platform
+------------------------
 
-Portal Platform
----------------
+.. list-table::
+   :widths: 20 80
+   :header-rows: 1
 
-.. toctree::
-   :maxdepth: 2
-   :titlesonly:
+   * - Document
+     - Description
+   * - :ref:`Portal<onap-portal:master_index>`
+     - ONAP Portal Platform Documentation
 
-   ../../../submodules/portal.git/docs/index
+SDC - Service Design & Creation
+-------------------------------
 
-Service Design & Creation
--------------------------
+.. list-table::
+   :widths: 20 80
+   :header-rows: 1
 
-.. toctree::
-   :maxdepth: 2
-   :titlesonly:
+   * - Document
+     - Description
+   * - :ref:`SDC<onap-sdc:master_index>`
+     - Service Design & Creation Documentation
 
-   ../../../submodules/sdc.git/docs/index
+SDNC - Software Defined Network Controller
+------------------------------------------
 
-.. Empty folders for this release
-   ../../../submodules/sdc/jtosca.git/docs/index
-   ../../../submodules/sdc/sdc-distribution-client.git/docs/index
-   ../../../submodules/sdc/sdc-docker-base.git/docs/index
-   ../../../submodules/sdc/sdc-titan-cassandra.git/docs/index
-   ../../../submodules/sdc/sdc-tosca.git/docs/index
-   ../../../submodules/sdc/sdc-workflow-designer.git/docs/index
+.. list-table::
+   :widths: 20 80
+   :header-rows: 1
 
-Service Orchestration
----------------------
+   * - Document
+     - Description
+   * - :ref:`SDCN<onap-sdnc-oam:master_index>`
+     - SDNC Architecture, APIs and Guides
 
-.. toctree::
-   :maxdepth: 2
-   :titlesonly:
+SDNR - Software Defined Network Controller for Radio
+----------------------------------------------------
 
-   ../../../submodules/so.git/docs/index
-   ../../../submodules/so/libs.git/docs/index
+.. list-table::
+   :widths: 20 80
+   :header-rows: 1
 
-Software Defined Network Controller
------------------------------------
+   * - Document
+     - Description
+   * - :ref:`SDNR<onap-ccsdk-features:master_index>`
+     - SDN-R Documentation (part of CCSDK)
 
-.. toctree::
-   :maxdepth: 2
-   :titlesonly:
+SO - Service Orchestration
+--------------------------
 
-   ../../../submodules/sdnc/oam.git/docs/index
+.. list-table::
+   :widths: 20 80
+   :header-rows: 1
 
-.. Empty folders for this release
-   ../../../submodules/sdnc/adaptors.git/docs/index
-   ../../../submodules/sdnc/architecture.git/docs/index
-   ../../../submodules/sdnc/core.git/docs/index
-   ../../../submodules/sdnc/features.git/docs/index
-   ../../../submodules/sdnc/northbound.git/docs/index
-   ../../../submodules/sdnc/parent.git/docs/index
-   ../../../submodules/sdnc/plugins.git/docs/index
+   * - Document
+     - Description
+   * - :ref:`SO<onap-so:master_index>`
+     - Service Orchestration Architecture, APIs and Guides
+   * - :ref:`SO Libraries<onap-so-libs:master_index>`
+     - Service Orchestration Build (To be deleted ?)
 
-Virtual Function Controller
----------------------------
+UUI - Use Case User Interface
+-----------------------------
 
-.. toctree::
-   :maxdepth: 2
-   :titlesonly:
+.. list-table::
+   :widths: 20 80
+   :header-rows: 1
 
-   ../../../submodules/vfc/nfvo/lcm.git/docs/index
+   * - Document
+     - Description
+   * - :ref:`UUI<onap-usecase-ui:master_index>`
+     - Usecase-UI Architecture, APIs and Guides
 
-Virtual Infrastructure Deployment
+VFC - Virtual Function Controller
 ---------------------------------
 
-.. toctree::
-   :maxdepth: 2
-   :titlesonly:
+.. list-table::
+   :widths: 20 80
+   :header-rows: 1
 
+   * - Document
+     - Description
+   * - :ref:`VF-C<onap-vfc-nfvo-lcm:master_index>`
+     - Virtual Function Controller Architecture, APIs and Guides
 
-   ../../../submodules/vid.git/docs/index
+VID - Virtual Infrastructure Deployment
+---------------------------------------
 
-.. Empty folders for this release
-   ../../../submodules/vid/asdcclient.git/docs/index
+.. list-table::
+   :widths: 20 80
+   :header-rows: 1
 
-VNF Requirements
-----------------
+   * - Document
+     - Description
+   * - :ref:`VID<onap-vid:master_index>`
+     - Virtual Infrastructure Deployment Architecture, APIs and Guides
 
-.. toctree::
-   :maxdepth: 2
-   :titlesonly:
+VNFSDK - VNF Software Development Kit
+-------------------------------------
 
+.. list-table::
+   :widths: 20 80
+   :header-rows: 1
 
-   ../../../submodules/vnfrqts/guidelines.git/docs/index
-   ../../../submodules/vnfrqts/requirements.git/docs/index
+   * - Document
+     - Description
+   * - :ref:`VnfSDK<onap-vnfsdk-model:master_index>`
+     - VNF SDK Documentation and User Guides
 
-VNF Software Development Kit
-----------------------------
+VVP - VNF Validation Platform
+-----------------------------
 
-.. toctree::
-   :maxdepth: 2
-   :titlesonly:
+.. list-table::
+   :widths: 20 80
+   :header-rows: 1
 
-   ../../../submodules/vnfsdk/model.git/docs/index
+   * - Document
+     - Description
+   * - :ref:`VVP<onap-vvp-documentation:master_index>`
+     - VNF Validation Platform Documentation