Update git submodules
[doc.git] / docs / index.rst
index 549850b..ee6933c 100644 (file)
@@ -1,6 +1,7 @@
 .. This work is licensed under a
    Creative Commons Attribution 4.0 International License.
 
+
 .. _master_index:
 
 Open Network Automation Platform
@@ -18,33 +19,54 @@ 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.
 
-The ONAP Platform architecture is built on the highly efficient cooperation of
-Design-time Framework activities with the functions provided by the
-Run-time Framework. The Design-time Framework defines resources, services
-and products, creates and manages processes and policies, provides a single
-platform for deploying and defining instantiation management besides many
-other activities. The Run-time framework manages the full lifecycle of
-networks, services, resources, topology, orchestrates delivery, provides
-monitoring via analytics and controls activities for applications and
-virtual functions.
-
-ONAP platform activities are supported by the Microservices support
-system and by the ONAP Portal.
+Please find some guidance here on the content of ONAP documentation:
 
-The following figure presents the high-level architecture of ONAP:
+ +---------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+
+ | 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. |
+ +---------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+
 
-.. image:: media/ONAP-architecture-high-level.png
-    :width: 800px
 
-For more details, see :ref:`ONAP Documentation <onap-documentation>` (or alternatively you can also use the navigation bar on the left).
 
 .. toctree::
    :maxdepth: 1
    :hidden:
 
+   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-developer/index
    guides/onap-provider/index
-
-