X-Git-Url: https://gerrit.onap.org/r/gitweb?p=doc.git;a=blobdiff_plain;f=docs%2Findex.rst;h=ee6933c2112925fe7b285e34c8360bc4f4b2a550;hp=9902db952c29e9de551fdadbdeb64bb253f06b29;hb=6dee0826a47d1b1468207b28fc10ac7c7760b661;hpb=2337d8973cbb4cfd88cf53f038c2fb53fa0a4a44 diff --git a/docs/index.rst b/docs/index.rst index 9902db952..ee6933c21 100644 --- 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. + .. _master_index: Open Network Automation Platform @@ -21,8 +22,11 @@ any product could on its own. Please find some guidance here on the content of ONAP documentation: +---------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+ - | Main documentation areas | Description | + | Main documentation areas | Description | +=================================================================================+===============================================================================================+ + | :ref:`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 ` | 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. | @@ -36,20 +40,16 @@ Please find some guidance here on the content of ONAP documentation: | | We can learn what functionalities ONAP provides and how the certain components in ONAP | | | operate together. | +---------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+ - | :ref:`Setting Up 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:`Operations and Adminstration 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 ` | The User Guides focus on tasks to administer Services using ONAP, covering Service Design, | + | | instantiation and their management using control loops | +---------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+ | :ref:`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 ` | 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 ` | 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. | @@ -62,11 +62,11 @@ Please find some guidance here on the content of ONAP documentation: :hidden: Home - guides/overview/index release/index + guides/overview/index guides/onap-developer/architecture/index guides/onap-developer/developing/index - guides/onap-developer/settingup/index - guides/onap-developer/index + guides/onap-operator/index guides/onap-user/index + guides/onap-developer/index guides/onap-provider/index