Code Review / doc.git / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | review | tree
raw | inline | side by side
improve use cases entry page
[doc.git] / docs / index.rst
diff --git a/docs/index.rst b/docs/index.rst
index ee6933c..df86f09 100644 (file)
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -1,9 +1,30 @@
 .. 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:
 
 .. _master_index:
 
+
+
+.. please disable below in the release version
+
+.. warning:: **WORK IN PROGRESS**
+
+   .. figure:: _static/exclamation-triangle.svg
+       :align: left
+       :scale: 760%
+       :figwidth: 120px
+       
+   This is a development version of ONAP documentation. It continually
+   develops as the contributing projects develop. Even if you read a specific
+   release name here, the content may cover a future ONAP release.
+   
+   **The official release documentation for ONAP 'Kohn' can be found**
+   `[here] <https://docs.onap.org/en/kohn/>`__
+
+|
+
+.. please disable above in the release version
+
 Open Network Automation Platform
 ================================
 
 Open Network Automation Platform
 ================================
 
@@ -19,42 +40,156 @@ 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.
 
 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 ONAP documentation:
-
- +---------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+
- | Main documentation areas                                                        | Description                                                                                   |
- +=================================================================================+===============================================================================================+
- | :ref:`Release Notes <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                    |
- |                                                                                 | 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:`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,...)     |
- +---------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+
- | :ref:`User Guides <user-guides>`                                                | The User Guides focus on tasks to administer Services using ONAP, covering Service Design,    |
- |                                                                                 | instantiation and their management using control loops                                        |
- +---------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+
- | :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:`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:`'Kohn' Release Notes <onap-release-notes>`
+------------------------------------------------
+
+.. figure:: _static/file.svg
+    :align: left
+    :scale: 300%
+    :figwidth: 50px
+    
+General information about the new ONAP release and recent changes, feature
+enhancements, or bug fixes.
+
+|
+
+:ref:`Component Release Notes <component-release-notes>`
+--------------------------------------------------------
+
+.. figure:: _static/files.svg
+    :align: left
+    :scale: 300%
+    :figwidth: 50px
+
+Project specific information about recent changes, features, enhancements, or
+bug fixes.
+
+|
+
+:ref:`Release History <release-history>`
+----------------------------------------
+
+.. figure:: _static/clock-history.svg
+    :align: left
+    :scale: 300%
+    :figwidth: 50px
+
+Names and release dates of previous ONAP versions.
+
+|
+
+-------------------------------------------------------------------------------
+
+:ref:`Use Cases, Blueprints, Requirements <usecases_entry>`
+-----------------------------------------------------------
+
+.. figure:: _static/bullseye.svg
+    :align: left
+    :scale: 300%
+    :figwidth: 50px
+
+ONAP covers a wide range of use cases for Communication Service Providers (CSP)
+and the open source networking industry. Read about the latest verified use
+cases, functional requirements and blueprints to achieve your goals.
+
+|
+
+-------------------------------------------------------------------------------
+
+:ref:`Overview <overview>`
+--------------------------
+
+.. figure:: _static/eye.svg
+    :align: left
+    :scale: 300%
+    :figwidth: 50px
+
+A 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:`Architecture <ONAP-architecture>`
+---------------------------------------
+
+.. figure:: _static/columns-gap.svg
+    :align: left
+    :scale: 300%
+    :figwidth: 50px
+
+A general description of functional ONAP components and how they interact.
+Covers the design-time and runtime framework, ONAP microservices and common
+services.
+
+|
+
+:ref:`Components and Functionalities <doc_onap-developer_guide_projects>`
+-------------------------------------------------------------------------
+
+.. figure:: _static/diagram-3.svg
+    :align: left
+    :scale: 300%
+    :figwidth: 50px
+
+A individual description of every ONAP component and its features.
+
+|
 
 
+-------------------------------------------------------------------------------
+
+:ref:`Operations and Administration Guides <operation_guides>`
+--------------------------------------------------------------
+
+.. figure:: _static/person-gear.svg
+    :align: left
+    :scale: 300%
+    :figwidth: 50px
+
+The installation of ONAP, its management, monitoring and other operational
+tasks like integration or user management are covered here.
+
+|
+
+:ref:`Developer Guides <ONAP_developer_guides>`
+-----------------------------------------------
+
+.. figure:: _static/code-slash.svg
+    :align: left
+    :scale: 300%
+    :figwidth: 50px
+
+Developers contributing to the ONAP development can find information here.
+
+|
+
+:ref:`Documentation Guides <ONAP_documentation_guides>`
+-------------------------------------------------------
+
+.. figure:: _static/filetype-rst.svg
+    :align: left
+    :scale: 300%
+    :figwidth: 50px
+
+A guide to set up a documentation development environment, documentation style
+guides, tips and templates are provided here.
+
+|
+
+-------------------------------------------------------------------------------
+
+:ref:`Vulnerabilities and Advisories <onap-security-index>`
+-----------------------------------------------------------
+
+.. figure:: _static/shield.svg
+    :align: left
+    :scale: 300%
+    :figwidth: 50px
+
+Describes the current state of ONAP Security. Learn about discovered and fixed
+vulnerabilities and how to report them.
 
 
 .. toctree::
 
 
 .. toctree::
@@ -62,11 +197,44 @@ Please find some guidance here on the content of ONAP documentation:
    :hidden:
 
    Home <self>
    :hidden:
 
    Home <self>
+
+.. toctree::
+   :maxdepth: 1
+   :hidden:  
+   :caption: RELEASE
+
    release/index
    release/index
-   guides/overview/index
-   guides/onap-developer/architecture/index
-   guides/onap-developer/developing/index
+   release/component-release-notes
+   release/history
+
+.. toctree::
+   :maxdepth: 1
+   :hidden:  
+   :caption: USE CASES
+
+   usecases/index
+
+.. toctree::
+   :maxdepth: 1
+   :hidden:  
+   :caption: PLATFORM
+
+   platform/overview/index
+   platform/architecture/index
+   platform/components/index
+
+.. toctree::
+   :maxdepth: 1
+   :hidden:  
+   :caption: GUIDES
+
    guides/onap-operator/index
    guides/onap-operator/index
-   guides/onap-user/index
    guides/onap-developer/index
    guides/onap-developer/index
-   guides/onap-provider/index
+   guides/onap-documentation/index
+
+.. toctree::
+   :maxdepth: 1
+   :hidden:
+   :caption: SECURITY
+
+   security/index
Create and maintain documentation targeted to ONAP user audiences