X-Git-Url: https://gerrit.onap.org/r/gitweb?a=blobdiff_plain;f=docs%2Findex.rst;h=895355d83494b069073182e5f503dca90d861416;hb=32b7b356f235088414ac78b3e0f737fe0376ca80;hp=83f8b8a81343c015fa7cdec153fad51a4fd9aaae;hpb=ac93e0eb246a03c02df7a6b7704aaabfdb7461f0;p=doc.git diff --git a/docs/index.rst b/docs/index.rst index 83f8b8a81..895355d83 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,20 +1,67 @@ -.. 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. -Welcome to ONAP documentation! +.. _master_index: + +Open Network Automation Platform ================================ -Contents: +Open Network Automation Platform (ONAP) is an open source project hosted by +the Linux Foundation. -.. toctree:: - :maxdepth: 1 +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. - release/index - how-to-use-docs/index +Please find some guidance here on the content of the Casablanca Release documentation for ONAP: -Indices and tables -================== + +-------------------------------------------------------+-----------------------------------------------------------------------------------------------+ + | Main documentation areas | Description | + +=======================================================+===============================================================================================+ + | :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:`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. | + +-------------------------------------------------------+-----------------------------------------------------------------------------------------------+ -* :ref:`genindex` -* :ref:`modindex` -* :ref:`search` +You can reach the complete Casablanca Release documentation from the Navigation bar on the left. +.. toctree:: + :maxdepth: 1 + :hidden: + + Home + guides/overview/index + release/index + guides/onap-developer/architecture/index + guides/onap-developer/settingup/index + guides/onap-developer/index + guides/onap-user/index + guides/onap-provider/index