X-Git-Url: https://gerrit.onap.org/r/gitweb?a=blobdiff_plain;f=docs%2Findex.rst;h=ee6933c2112925fe7b285e34c8360bc4f4b2a550;hb=d081cc7ba283c1c316607f1b0c2a52b8c4457d6a;hp=fbcb897a9e0c332f5f29d7c2b962c64c03a7139a;hpb=872102df6cf68e3a5cb57b4632edab34a453da44;p=doc.git diff --git a/docs/index.rst b/docs/index.rst index fbcb897a9..ee6933c21 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,22 +1,72 @@ -.. 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 +================================ -.. toctree:: - :maxdepth: 2 +Open Network Automation Platform (ONAP) is an open source project hosted by +the Linux Foundation. - release/index - guides/onap-developer/index - guides/onap-user/index - use-cases/index +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:`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:`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. | + +---------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+ -Index and Search -================ -* :ref:`genindex` -* :ref:`search` +.. toctree:: + :maxdepth: 1 + :hidden: + + Home + release/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