X-Git-Url: https://gerrit.onap.org/r/gitweb?a=blobdiff_plain;f=docs%2Findex.rst;h=fc772b8bb2da9f3cc1c92e73defb00cbabf4306c;hb=20e99b50e50fd39bc1ab5f84acf5f8a396804ce9;hp=549850bf85666de42b532d331dac6017affee6bb;hpb=f3d08c0685404ec2b61af5ea937b6d7b90543a40;p=doc.git diff --git a/docs/index.rst b/docs/index.rst index 549850bf8..fc772b8bb 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -18,33 +18,58 @@ 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. +Please find some guidance here on the content of ONAP documentation: -ONAP platform activities are supported by the Microservices support -system and by the ONAP Portal. + +---------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+ + | 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. | + +---------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+ + | :ref:`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 ` | 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 ` | 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 ` | 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. | + +---------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+ -The following figure presents the high-level architecture of ONAP: -.. image:: media/ONAP-architecture-high-level.png - :width: 800px - -For more details, see :ref:`ONAP Documentation ` (or alternatively you can also use the navigation bar on the left). .. toctree:: :maxdepth: 1 :hidden: + Home 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-user/index guides/onap-provider/index - -