diff options
author | thmsdt <thomas.kulik@telekom.de> | 2022-11-24 16:56:33 +0100 |
---|---|---|
committer | thmsdt <thomas.kulik@telekom.de> | 2022-11-28 13:47:50 +0100 |
commit | 24579642cb3a0fb575a36d1eed52ecde88df3eac (patch) | |
tree | dc1ecd867de4df62f4c6a605615d4ec6e0be440b /docs/index.rst | |
parent | 87edb65288e04f2f6afda9ca853db37521578b4a (diff) |
rework of index page; add icons
Issue-ID: DOC-798
Signed-off-by: thmsdt <thomas.kulik@telekom.de>
Change-Id: Icebb12289c67e064e0d948d857cc65ff2444d5b1
(cherry picked from commit e2eedb51b3b99d65e2ac76834286ae6fe64bddcf)
Diffstat (limited to 'docs/index.rst')
-rw-r--r-- | docs/index.rst | 187 |
1 files changed, 147 insertions, 40 deletions
diff --git a/docs/index.rst b/docs/index.rst index a0e1feec5..8b589c630 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -18,46 +18,153 @@ 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. -Please find some guidance here on the content of ONAP documentation: - - +---------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+ - | Documentation areas | Description | - +=================================================================================+===============================================================================================+ - | :ref:`ONAP 'Kohn' Release Notes <onap-release-notes>` | The Release Notes are providing general information about the ONAP release and recent changes,| - | | feature enhancements, or bug fixes. | - +---------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+ - | :ref:`Component Release Notes <component-release-notes>` | The Component Release Notes are providing project specific information about recent changes, | - | | features, enhancements, or bug fixes. | - +---------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+ - | :ref:`ONAP Release History <release-history>` | The list contains the name and date of previous ONAP releases. | - +---------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+ - | :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. You can learn| - | | how the two main frameworks, namely the Design-time framework and the Run-time framework | - | | cooperate and how the Microservices and Common services support certain functions. | - +---------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+ - | :ref:`ONAP Components and Functionalities <doc_onap-developer_guide_projects>` | The ONAP Components and Functionalities are described in details here. You can learn what | - | | functionalities ONAP provides and how the certain components in ONAP operate together. | - +---------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+ - | :ref:`Operations and Adminstration Guides <operation_guides>` | ONAP Platform Operations and Adminstration covers 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. You 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 Documentation Guide. | - +---------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+ - | :ref:`ONAP Security <onap-security-index>` | The current state of ONAP Security is described here. You can learn about discovered and fixed| - | | vulnerabilities. | - +---------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+ +------------------------------------------------------------------------------- + +: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:`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:`User Guides <user-guides>` +-------------------------------- + +.. figure:: _static/person.svg + :align: left + :scale: 300% + :figwidth: 50px + +The User Guides focus on tasks to administer services using ONAP, covering +service design, instantiation and management using control loops. + +| + +: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:: |