X-Git-Url: https://gerrit.onap.org/r/gitweb?a=blobdiff_plain;f=docs%2Findex.rst;h=0caf4694005034d0469b00c3b826b5f6a9fbfe55;hb=54909f22c151a8d848d9c53b7843066bf591bb38;hp=04b916979d3278bdb0adff27712a03fbd8979807;hpb=0c9874ceec99ff32f1f3c98dea463980db9dbe74;p=doc.git diff --git a/docs/index.rst b/docs/index.rst index 04b916979..0caf46940 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,6 +1,7 @@ .. This work is licensed under a Creative Commons Attribution 4.0 International License. + .. _master_index: Open Network Automation Platform @@ -23,21 +24,24 @@ 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:`Release Notes ` | The Release Notes are providing general information about the ONAP release and recent changes,| + | | feature enhancements, or bug fixes. | + +---------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+ + | :ref:`Project Specific Release Notes ` | The Project Specific Release Notes are providing information about recent changes, feature | + | | enhancements, or bug fixes on a component level. | +---------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+ | :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 | + | :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:`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,...) | @@ -49,9 +53,12 @@ Please find some guidance here on the content of ONAP documentation: | | 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. | + | :ref:`Documentation Guides ` | People interested in the creation of ONAP documentation can find crucial information | + | | in the ONAP Documentation Guide. Currently some content resides also in the Developer Guide. | + | | This is subject to be reviewed, updated and migrated to the ONAP Documenation Guide. | + +---------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+ + | :ref:`ONAP Security ` | The current state of ONAP Security is described here. We can learn about discovered and fixed | + | | vulnerabilities. | +---------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+ @@ -61,10 +68,11 @@ Please find some guidance here on the content of ONAP documentation: Home release/index + release/releaserepos 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 + guides/onap-documentation/index