X-Git-Url: https://gerrit.onap.org/r/gitweb?a=blobdiff_plain;f=docs%2Findex.rst;h=749af32b0478407a63cafe5197216b2a96522773;hb=8595cb6ea1d5614b8b05d5ad760e4159a7af48d2;hp=9c69842f780e9017f9380cf55eb51c4f79390788;hpb=60e4b026e86295d03de32b60c492e1f62662dac9;p=doc.git diff --git a/docs/index.rst b/docs/index.rst index 9c69842f7..749af32b0 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,31 +1,66 @@ -.. 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 +================================ -.. caution:: - This version of documentation is created from the latest master branch of - source repositories and is not a stable release. To get the current stable - release use one of the following +Open Network Automation Platform (ONAP) is an open source project hosted by +the Linux Foundation. - * http://docs.onap.org - * http://docs.onap.org/en/beijing - * the selector on the bottom right and select beijing +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 the Casablanca Release documentation for ONAP: + + +-------------------------------------------------------+-----------------------------------------------------------------------------------------------+ + | 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. | + +-------------------------------------------------------+-----------------------------------------------------------------------------------------------+ + +You can reach the complete Casablanca Release documentation from the Navigation bar on the left. .. toctree:: - :maxdepth: 2 + :maxdepth: 1 + :hidden: + Home release/index + guides/onap-developer/architecture/index + guides/onap-developer/settingup/index guides/onap-developer/index guides/onap-user/index guides/onap-provider/index - - - -Index and Search -================ - -* :ref:`genindex` -* :ref:`search`