Merge "Structural changes to documentation"

diff --git a/docs/guides/onap-developer/developing/index.rst b/docs/guides/onap-developer/developing/index.rst
index d481933..13a1e21 100644 (file)
--- a/docs/guides/onap-developer/developing/index.rst
+++ b/docs/guides/onap-developer/developing/index.rst
@@ -7,8 +7,8 @@
 
 .. _doc_onap-developer_guide_projects:
 
-Developing ONAP
-===============
+ONAP components and functionalities
+===================================
 Additional developer level detail is provided for each project below.
 
 Active and Available Inventory

diff --git a/docs/guides/onap-developer/index.rst b/docs/guides/onap-developer/index.rst
index 011cc57..221f7ca 100644 (file)
--- a/docs/guides/onap-developer/index.rst
+++ b/docs/guides/onap-developer/index.rst
@@ -7,15 +7,12 @@
 Developer Guides
 ================
 The following guides are provided for developers who want to
-understanding or contribute to the ONAP open source.
+understand or contribute to the ONAP open source.
 
 .. toctree::
    :maxdepth: 1
 
-   architecture/index
    tutorials/index
-   settingup/index
-   developing/index
    how-to-use-docs/index
    apiref/index
 

diff --git a/docs/guides/overview/index.rst b/docs/guides/overview/index.rst
index 403c398..2b1c4be 100644 (file)
--- a/docs/guides/overview/index.rst
+++ b/docs/guides/overview/index.rst
@@ -6,7 +6,9 @@
 .. index:: Overview
 
 ONAP Overview
-=========================================
+=============
+
+.. _overview:
 
 .. toctree::
    :maxdepth: 2

diff --git a/docs/index.rst b/docs/index.rst
index 5ff62a7..04eff22 100644 (file)
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -20,37 +20,40 @@ any product could on its own.
 
 Please find some guidance here on the content of the Dublin Release documentation for ONAP:
 
- +---------------------------------------------------------------+-----------------------------------------------------------------------------------------------+
- | Main documentation areas                                     |   Description                                                                                 |
- +===============================================================+===============================================================================================+
- | :ref:`ONAP Overview <getting-started>`                        | ONAP Overview provides generic and high-level guidance on the mission and main                |
- |                                                               | functionalities of ONAP. Basic guidelines on license details, limitations and                 |
- |                                                               | security references support understanding the solution.                                       |
- +---------------------------------------------------------------+-----------------------------------------------------------------------------------------------+
- | :ref:`ONAP Architecture <ONAP-architecture>`                  | The ONAP architecture and its functional elements are described in details                    |
- |                                                               | here. We can learn how the two main frameworks, namely the Design-time                        |
- |                                                               | framework and the Run-time framework cooperate and how the Microservices,                     |
- |                                                               | Common services and the ONAP Portal support the certain functions.                            |
- +---------------------------------------------------------------+-----------------------------------------------------------------------------------------------+
- | :ref:`Setting Up ONAP <installing-onap>`                      | Installation guidelines and requirements help the very first set up of an                     |
- |                                                               | ONAP environment. The ONAP Operations Manager Cloud setup Guide and the                       |
- |                                                               | ONAP Operations Manager Quick Start Guide support the deployment and installation activities. |
- +---------------------------------------------------------------+-----------------------------------------------------------------------------------------------+
- | :ref:`Developer Guides <ONAP_developer_guides>`               | Developers contributing to the ONAP development can find crucial information                  |
- |                                                               | in the Developer Guides. The reader can search among the developers’ topics                   |
- |                                                               | in alphabetical order.                                                                        |
- +---------------------------------------------------------------+-----------------------------------------------------------------------------------------------+
- | :ref:`User Guides <user-guides>`                              | The User Guides provide details on the ONAP portal, which portal integrates                   |
- |                                                               | numerous different ONAP applications at one place. Platform operations are                    |
- |                                                               | supported with ONAP Operations Quick Start Guide and with an ONAP Operations                  |
- |                                                               | User Guide. The instantiation and the management of resources and the services                |
- |                                                               | are supported with a Service Design Guide and with guidelines on Service Deployment.          |
- +---------------------------------------------------------------+-----------------------------------------------------------------------------------------------+
- | :ref:`VNF and PNF Requirements and Guidelines <vnf_pnf_reqs>` | Harmonized VNF and PNF requirements and reduced customization of onboarding VNFs              |
- |                                                               | and PNFs can accelerate the optimal usage of this ONAP environment. The guidelines            |
- |                                                               | on VNF and PNF requirements facilitates synchronized and aligned activities for all           |
- |                                                               | participants.                                                                                 |
- +---------------------------------------------------------------+-----------------------------------------------------------------------------------------------+
+ +---------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+
+ | Main documentation areas                                                       | Description                                                                                   |
+ +=================================================================================+===============================================================================================+
+ | :ref:`ONAP Overview <overview>`                                                 | ONAP Overview provides generic and high-level guidance on the mission and main                |
+ |                                                                                 | functionalities of ONAP. Basic guidelines on license details, limitations and                 |
+ |                                                                                 | security references support understanding the solution.                                       |
+ +---------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+
+ | :ref:`ONAP Architecture <ONAP-architecture>`                                    | The ONAP architecture and its functional elements are described in details                    |
+ |                                                                                 | here. We can learn how the two main frameworks, namely the Design-time                        |
+ |                                                                                 | framework and the Run-time framework cooperate and how the Microservices,                     |
+ |                                                                                 | Common services and the ONAP Portal support the certain functions.                            |
+ +---------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+
+ | :ref:`ONAP components and functionalities <doc_onap-developer_guide_projects>`  | The ONAP components and functionalities are described in details here.                        |
+ |                                                                                 | We can learn what functionalities ONAP provides and how the certain components in ONAP        |
+ |                                                                                 | operate together.                                                                             |
+ +---------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+
+ | :ref:`Setting Up ONAP <installing-onap>`                                        | Installation guidelines and requirements help the very first set up of an                     |
+ |                                                                                 | ONAP environment. The ONAP Operations Manager Cloud setup Guide and the                       |
+ |                                                                                 | ONAP Operations Manager Quick Start Guide support the deployment and installation activities. |
+ +---------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+
+ | :ref:`Developer Guides <ONAP_developer_guides>`                                 | Developers contributing to the ONAP development can find crucial information                  |
+ |                                                                                 | in the Developer Guides. The reader can search among the developers’ topics                   |
+ |                                                                                 | in alphabetical order.                                                                        |
+ +---------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+
+ | :ref:`User Guides <user-guides>`                                                | The User Guides provide details on the ONAP portal, which portal integrates                   |
+ |                                                                                 | numerous different ONAP applications at one place. Platform operations are                    |
+ |                                                                                 | supported with ONAP Operations Quick Start Guide and with an ONAP Operations                  |
+ |                                                                                 | User Guide. The instantiation and the management of resources and the services                |
+ |                                                                                 | are supported with a Service Design Guide and with guidelines on Service Deployment.          |
+ +---------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+
+ | :ref:`VNF/PNF Requirements and Guidelines <vnf_reqs>`                           | Harmonized VNF and PNF requirements and reduced customization of onboarding VNFs              |
+ |                                                                                 | and PNFs can accelerate the optimal usage of this ONAP environment. The guidelines            |
+ |                                                                                 | on VNF/PNF requirements facilitates synchronized and aligned activities for all participants. |
+ +---------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+
 
 You can reach the complete set of Dublin Release documentation from the Navigation bar on the left.
 
@@ -62,6 +65,7 @@ You can reach the complete set of Dublin Release documentation from the Navigati
    guides/overview/index
    release/index
    guides/onap-developer/architecture/index
+   guides/onap-developer/developing/index
    guides/onap-developer/settingup/index
    guides/onap-developer/index
    guides/onap-user/index