Update git submodules

[doc.git] / docs / index.rst

diff --git a/docs/index.rst b/docs/index.rst
index 99afecc..ee6933c 100644 (file)
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -1,6 +1,7 @@
 .. 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.
 

+

 .. _master_index:
 
 Open Network Automation Platform
 .. _master_index:
 
 Open Network Automation Platform


@@ -18,40 +19,43 @@ the acceleration of the development of a vibrant ecosystem around a globally
 shared architecture and the implementation of network automation faster than
 any product could on its own.
 
 shared architecture and the implementation of network automation faster than
 any product could on its own.
 

-Please find some guidance here on the content of the Casablanca Release documentation for ONAP:
+Please find some guidance here on the content of ONAP documentation:
+
+ +---------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+
+ | Main documentation areas                                                        | Description                                                                                   |
+ +=================================================================================+===============================================================================================+
+ | :ref:`Release Notes <release-notes>`                                            | The Release Notes besides providing the basic information on the main release, also           |
+ |                                                                                 | presents link to the release information of each, specific ONAP component.                    |
+ +---------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+
+ | :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:`Operations and Adminstration Guides <operation_guides>`                   | ONAP Platform operation and adminstration cover the configuration and installation of ONAP,   |
+ |                                                                                 | its management, monitoring and other operational tasks (integration, user management,...)     |
+ +---------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+
+ | :ref:`User Guides <user-guides>`                                                | The User Guides focus on tasks to administer Services using ONAP, covering Service Design,    |
+ |                                                                                 | instantiation and their management using control loops                                        |
+ +---------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+
+ | :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:`VNF/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/PNF requirements facilitates synchronized and aligned activities for all participants. |
+ +---------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+

 
 

- +-------------------------------------------------------+-----------------------------------------------------------------------------------------------+
- | 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/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 Casablanca Release documentation from the Navigation bar on the left.

 
 .. toctree::
    :maxdepth: 1
 
 .. toctree::
    :maxdepth: 1


@@ -59,8 +63,10 @@ You can reach the complete Casablanca Release documentation from the Navigation
 
    Home <self>
    release/index
 
    Home <self>
    release/index

-   guides/onap-developer/index
+   guides/overview/index
+   guides/onap-developer/architecture/index
+   guides/onap-developer/developing/index
+   guides/onap-operator/index

    guides/onap-user/index
    guides/onap-user/index

+   guides/onap-developer/index

    guides/onap-provider/index
    guides/onap-provider/index

-
-