X-Git-Url: https://gerrit.onap.org/r/gitweb?a=blobdiff_plain;f=docs%2Findex.rst;h=fc772b8bb2da9f3cc1c92e73defb00cbabf4306c;hb=2fc98de37966e5dee92214457d6803c869240d64;hp=35f17f92c33ee687bb69a61f6a67f4532a3b066a;hpb=8f2c72fcc8e38f2c36a52d19a416748c9aba3849;p=doc.git diff --git a/docs/index.rst b/docs/index.rst index 35f17f92c..fc772b8bb 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,32 +1,75 @@ -.. 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: -ONAP Documentation -================== +Open Network Automation Platform +================================ -.. note:: - This version of documentation is created from the latest master branch of - source repositories and is not a stable release. +Open Network Automation Platform (ONAP) is an open source project hosted by +the Linux Foundation. + +ONAP provides a comprehensive platform for real-time, policy-driven service +orchestration and automation. ONAP enables service providers and developers +to rapidly automate the instantiation and configuration of physical and +virtual network functions and to support complete life cycle management +activities. By unifying the resources of open source members, ONAP enables +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. + +Please find some guidance here on the content of ONAP documentation: + + +---------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+ + | 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. | + +---------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+ - To get the current stable release use one of the following - * http://docs.onap.org - * http://docs.onap.org/en/beijing - * the selector on the bottom right and select beijing .. toctree:: - :maxdepth: 2 + :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 - use-cases/index - - - -Index and Search -================ - -* :ref:`genindex` -* :ref:`search` + guides/onap-provider/index