From e2eedb51b3b99d65e2ac76834286ae6fe64bddcf Mon Sep 17 00:00:00 2001 From: thmsdt Date: Thu, 24 Nov 2022 16:56:33 +0100 Subject: rework of index page; add icons Issue-ID: DOC-798 Signed-off-by: thmsdt Change-Id: Icebb12289c67e064e0d948d857cc65ff2444d5b1 --- docs/index.rst | 186 +++++++++++++++++++++++++++++++++++++++++++++------------ 1 file changed, 147 insertions(+), 39 deletions(-) (limited to 'docs/index.rst') diff --git a/docs/index.rst b/docs/index.rst index 4c16f0ebc..529e34068 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -18,45 +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 ` | The Release Notes are providing general information about the ONAP release and recent changes,| - | | feature enhancements, or bug fixes. | - +---------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+ - | :ref:`Component Release Notes ` | The Component Release Notes are providing project specific information about recent changes, | - | | features, enhancements, or bug fixes. | - +---------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+ - | :ref:`ONAP Release History ` | The list contains the name and date of previous ONAP releases. | - +---------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+ - | :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 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 ` | 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 ` | 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 ` | The User Guides focus on tasks to administer Services using ONAP, covering Service Design, | - | | instantiation and their management using control loops | - +---------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+ - | :ref:`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 ` | People interested in the creation of ONAP documentation can find crucial information in the | - | | ONAP Documentation Guide. | - +---------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+ - | :ref:`ONAP Security ` | The current state of ONAP Security is described here. You can learn about discovered and fixed| - | | vulnerabilities. | - +---------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+ +------------------------------------------------------------------------------- + +:ref:`'Kohn' 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 ` +-------------------------------------------------------- + +.. figure:: _static/files.svg + :align: left + :scale: 300% + :figwidth: 50px + +Project specific information about recent changes, features, enhancements, or +bug fixes. + +| + +:ref:`Release History ` +---------------------------------------- + +.. figure:: _static/clock-history.svg + :align: left + :scale: 300% + :figwidth: 50px + +Names and release dates of previous ONAP versions. + +| + +------------------------------------------------------------------------------- + +:ref:`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 ` +--------------------------------------- + +.. 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 ` +------------------------------------------------------------------------- + +.. 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 ` +-------------------------------------------------------------- + +.. 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 ` +-------------------------------- + +.. 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 ` +----------------------------------------------- + +.. figure:: _static/code-slash.svg + :align: left + :scale: 300% + :figwidth: 50px + +Developers contributing to the ONAP development can find information here. + +| + +:ref:`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 ` +----------------------------------------------------------- + +.. 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:: -- cgit 1.2.3-korg