fix sphinx config example files and update readme

[doc.git] / docs / index.rst

diff --git a/docs/index.rst b/docs/index.rst
index 0605227..f7cfd7b 100644 (file)
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -24,21 +24,21 @@ Please find some guidance here on the content of ONAP documentation:
  +---------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+
  | Main documentation areas                                                        | Description                                                                                   |
  +=================================================================================+===============================================================================================+
- | :ref:`Release Notes <release-notes>`                                            | The Release Notes besides providing the basic information on the main release, also           |
+ | :ref:`Release Notes <onap-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:`ONAP Overview <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 <ONAP-architecture>`                                    | The ONAP architecture and its functional elements are described in details                    |
+ | :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:`ONAP components and functionalities <doc_onap-developer_guide_projects>`  | 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 <doc_onap-developer_guide_projects>`  | 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 <operation_guides>`                   | ONAP Platform operation and adminstration cover the configuration and installation of ONAP,   |
  |                                                                                 | its management, monitoring and other operational tasks (integration, user management,...)     |
@@ -50,10 +50,17 @@ 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:`Documentation Guides <ONAP_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:`VNF/PNF Requirements and Guidelines <vnf_pnf_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. |
  +---------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+
+ | :ref:`ONAP Security <onap-security>`                                            | The current state of ONAP Security is described here. We can learn about discovered and fixed |
+ |                                                                                 | vulnerabilities.                                                                              |
+ +---------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+
 
 
 .. toctree::
@@ -68,4 +75,5 @@ Please find some guidance here on the content of ONAP documentation:
    guides/onap-operator/index
    guides/onap-user/index
    guides/onap-developer/index
+   guides/onap-documentation/index
    guides/onap-provider/index