diff options
| author |   Noemi Wagner <noemi.wagner@nokia.com> | 2018-12-11 11:50:05 +0100 |
|---|---|---|
| committer | Noemi Wagner <noemi.wagner@nokia.com> | 2018-12-11 14:47:06 +0100 |
| commit | 9aac72a5d0a7e47ead00f8bf54fb327709ac5343 (patch) | |
| tree | 04ad81cb8f30617f0831aa54c4cad8cfb5800580 /docs/documentation.rst | |
| parent | b703608694c742b19afda4b1d9bceafa92781feb (diff) | |
TOC replaced
The documentation page shall not repeat the Table
of contents (TOC) of the docs,
that is anyway available from the navigation bar, but shall
provide additional information on the content of the docs.
Issue-ID: DOC-353
Change-Id: I88c3f8a549d0f6b4d170f969aa8aa4a069dc2cc3
Signed-off-by: Noemi Wagner <noemi.wagner@nokia.com>
Diffstat (limited to 'docs/documentation.rst')
| -rw-r--r-- | docs/documentation.rst | 41 |
1 files changed, 35 insertions, 6 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 |