diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/documentation.rst | 41 | ||||
| -rw-r--r-- | docs/guides/onap-developer/architecture/onap-architecture.rst | 2 | ||||
| -rw-r--r-- | docs/guides/onap-provider/index.rst | 2 | ||||
| -rw-r--r-- | docs/guides/onap-user/index.rst | 2 | ||||
| -rw-r--r-- | docs/release/index.rst | 1 |
5 files changed, 40 insertions, 8 deletions
diff --git a/docs/documentation.rst b/docs/documentation.rst index 90d917c74..b0ceb914c 100644 --- a/docs/documentation.rst +++ b/docs/documentation.rst @@ -4,10 +4,39 @@ ONAP Documentation ================== -.. toctree:: - :maxdepth: 2 +Welcome to the Open Network Automation Platform (ONAP) documentation site for the Casablanca Release! + +Please find some guidance here on the content of the Casablanca Release documentation for ONAP: + + +-------------------------------------------------------+-----------------------------------------------------------------------------------------------+ + | Main documentation areas | Description | + +=======================================================+===============================================================================================+ + | :ref:`ONAP Overview <getting-started>` | 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 <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 <installing-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 <ONAP_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 <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 <vnf_reqs>` | 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. - release/index - guides/onap-developer/index - guides/onap-user/index - guides/onap-provider/index diff --git a/docs/guides/onap-developer/architecture/onap-architecture.rst b/docs/guides/onap-developer/architecture/onap-architecture.rst index e850865ed..8455f7e61 100644 --- a/docs/guides/onap-developer/architecture/onap-architecture.rst +++ b/docs/guides/onap-developer/architecture/onap-architecture.rst @@ -3,6 +3,8 @@ .. http://creativecommons.org/licenses/by/4.0 .. Copyright 2017-2018 Huawei Technologies Co., Ltd. +.. _ONAP-architecture: + 1. Introduction =============== diff --git a/docs/guides/onap-provider/index.rst b/docs/guides/onap-provider/index.rst index 55702a148..5820c5ebe 100644 --- a/docs/guides/onap-provider/index.rst +++ b/docs/guides/onap-provider/index.rst @@ -2,7 +2,7 @@ .. International License. http://creativecommons.org/licenses/by/4.0 .. Copyright 2017 AT&T Intellectual Property. All rights reserved. - +.. _vnf_reqs: VNF Requirements and Guidelines =============================== diff --git a/docs/guides/onap-user/index.rst b/docs/guides/onap-user/index.rst index 5592194ff..39c2a32c4 100644 --- a/docs/guides/onap-user/index.rst +++ b/docs/guides/onap-user/index.rst @@ -2,7 +2,7 @@ .. International License. http://creativecommons.org/licenses/by/4.0 .. Copyright 2017 AT&T Intellectual Property. All rights reserved. - +.. _user-guides: User Guides =========== diff --git a/docs/release/index.rst b/docs/release/index.rst index c438dcb5e..44942d468 100644 --- a/docs/release/index.rst +++ b/docs/release/index.rst @@ -11,6 +11,7 @@ using city names. * Release Version: 3.0.0 * Release Date: Nov 30, 2018 +.. _getting-started: Getting Started With ONAP ========================= |