From e2eedb51b3b99d65e2ac76834286ae6fe64bddcf Mon Sep 17 00:00:00 2001 From: thmsdt Date: Thu, 24 Nov 2022 16:56:33 +0100 Subject: [PATCH] rework of index page; add icons Issue-ID: DOC-798 Signed-off-by: thmsdt Change-Id: Icebb12289c67e064e0d948d857cc65ff2444d5b1 --- docs/_static/calendar-event.svg | 4 + docs/_static/clock-history.svg | 5 + docs/_static/code-slash.svg | 3 + docs/_static/columns-gap.svg | 3 + docs/_static/diagram-3.svg | 3 + docs/_static/eye.svg | 4 + docs/_static/file.svg | 3 + docs/_static/files.svg | 3 + docs/_static/filetype-rst.svg | 47 +++++++++ docs/_static/person-gear.svg | 3 + docs/_static/person.svg | 3 + docs/_static/shield.svg | 3 + docs/_static/terminal.svg | 4 + docs/index.rst | 186 +++++++++++++++++++++++++++-------- docs/platform/architecture/index.rst | 4 +- docs/platform/components/index.rst | 4 +- docs/platform/overview/index.rst | 4 +- docs/release/history.rst | 4 +- docs/release/index.rst | 6 +- docs/security/index.rst | 4 +- 20 files changed, 248 insertions(+), 52 deletions(-) create mode 100644 docs/_static/calendar-event.svg create mode 100644 docs/_static/clock-history.svg create mode 100644 docs/_static/code-slash.svg create mode 100644 docs/_static/columns-gap.svg create mode 100644 docs/_static/diagram-3.svg create mode 100644 docs/_static/eye.svg create mode 100644 docs/_static/file.svg create mode 100644 docs/_static/files.svg create mode 100644 docs/_static/filetype-rst.svg create mode 100644 docs/_static/person-gear.svg create mode 100644 docs/_static/person.svg create mode 100644 docs/_static/shield.svg create mode 100644 docs/_static/terminal.svg diff --git a/docs/_static/calendar-event.svg b/docs/_static/calendar-event.svg new file mode 100644 index 000000000..41c0ef9b4 --- /dev/null +++ b/docs/_static/calendar-event.svg @@ -0,0 +1,4 @@ + + + + \ No newline at end of file diff --git a/docs/_static/clock-history.svg b/docs/_static/clock-history.svg new file mode 100644 index 000000000..414b526c6 --- /dev/null +++ b/docs/_static/clock-history.svg @@ -0,0 +1,5 @@ + + + + + \ No newline at end of file diff --git a/docs/_static/code-slash.svg b/docs/_static/code-slash.svg new file mode 100644 index 000000000..ef0ef0181 --- /dev/null +++ b/docs/_static/code-slash.svg @@ -0,0 +1,3 @@ + + + \ No newline at end of file diff --git a/docs/_static/columns-gap.svg b/docs/_static/columns-gap.svg new file mode 100644 index 000000000..b3cb17536 --- /dev/null +++ b/docs/_static/columns-gap.svg @@ -0,0 +1,3 @@ + + + \ No newline at end of file diff --git a/docs/_static/diagram-3.svg b/docs/_static/diagram-3.svg new file mode 100644 index 000000000..464b051d8 --- /dev/null +++ b/docs/_static/diagram-3.svg @@ -0,0 +1,3 @@ + + + \ No newline at end of file diff --git a/docs/_static/eye.svg b/docs/_static/eye.svg new file mode 100644 index 000000000..412ff6928 --- /dev/null +++ b/docs/_static/eye.svg @@ -0,0 +1,4 @@ + + + + \ No newline at end of file diff --git a/docs/_static/file.svg b/docs/_static/file.svg new file mode 100644 index 000000000..3562fb2b2 --- /dev/null +++ b/docs/_static/file.svg @@ -0,0 +1,3 @@ + + + \ No newline at end of file diff --git a/docs/_static/files.svg b/docs/_static/files.svg new file mode 100644 index 000000000..f8842f89b --- /dev/null +++ b/docs/_static/files.svg @@ -0,0 +1,3 @@ + + + \ No newline at end of file diff --git a/docs/_static/filetype-rst.svg b/docs/_static/filetype-rst.svg new file mode 100644 index 000000000..5db1a7e26 --- /dev/null +++ b/docs/_static/filetype-rst.svg @@ -0,0 +1,47 @@ + + + + + + + diff --git a/docs/_static/person-gear.svg b/docs/_static/person-gear.svg new file mode 100644 index 000000000..8024d86c7 --- /dev/null +++ b/docs/_static/person-gear.svg @@ -0,0 +1,3 @@ + + + \ No newline at end of file diff --git a/docs/_static/person.svg b/docs/_static/person.svg new file mode 100644 index 000000000..18d641190 --- /dev/null +++ b/docs/_static/person.svg @@ -0,0 +1,3 @@ + + + \ No newline at end of file diff --git a/docs/_static/shield.svg b/docs/_static/shield.svg new file mode 100644 index 000000000..18309d181 --- /dev/null +++ b/docs/_static/shield.svg @@ -0,0 +1,3 @@ + + + \ No newline at end of file diff --git a/docs/_static/terminal.svg b/docs/_static/terminal.svg new file mode 100644 index 000000000..e12c9f882 --- /dev/null +++ b/docs/_static/terminal.svg @@ -0,0 +1,4 @@ + + + + \ No newline at end of file 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:: diff --git a/docs/platform/architecture/index.rst b/docs/platform/architecture/index.rst index 11f7c09da..d5f06bf83 100644 --- a/docs/platform/architecture/index.rst +++ b/docs/platform/architecture/index.rst @@ -8,8 +8,8 @@ .. _ONAP-architecture: -ONAP Architecture -================= +Architecture +============ ONAP is a comprehensive platform for orchestration, management, and automation of network and edge computing services for network operators, cloud providers, and enterprises. Real-time, policy-driven orchestration and automation of diff --git a/docs/platform/components/index.rst b/docs/platform/components/index.rst index 36155cf5a..40d1e1409 100644 --- a/docs/platform/components/index.rst +++ b/docs/platform/components/index.rst @@ -7,8 +7,8 @@ .. _doc_onap-developer_guide_projects: -ONAP Components and Functionalities -=================================== +Components and Functionalities +============================== Here you will find the detailed documentation of maintained projects, ONAP components and functionalities. diff --git a/docs/platform/overview/index.rst b/docs/platform/overview/index.rst index 47422502b..9c1a14829 100644 --- a/docs/platform/overview/index.rst +++ b/docs/platform/overview/index.rst @@ -4,8 +4,8 @@ .. Copyright 2019 Nokia; Copyright 2017-2018 Huawei Technologies Co., Ltd.; .. Copyright 2017 AT&T Intellectual Property -ONAP Overview -============= +Overview +======== The Open Network Automation Platform (ONAP) project addresses the rising need for a **common automation platform for telecommunication, cable, diff --git a/docs/release/history.rst b/docs/release/history.rst index 245048368..c7d9e50a6 100644 --- a/docs/release/history.rst +++ b/docs/release/history.rst @@ -4,8 +4,8 @@ .. _release-history: -ONAP Release History --------------------- +Release History +--------------- ONAP is enhanced with numerous features from release to release. Each release is named after a city. diff --git a/docs/release/index.rst b/docs/release/index.rst index f24c88f36..2b58d213a 100644 --- a/docs/release/index.rst +++ b/docs/release/index.rst @@ -5,8 +5,8 @@ .. _onap-release-notes: -ONAP 'Kohn' Release Notes -============================ +'Kohn' Release Notes +==================== This page provides the release notes for the ONAP 'Kohn' release. This includes details of software versions, known limitations, and outstanding @@ -36,7 +36,7 @@ Kohn Major Release 11.0.0 Features -------- -ONAP Kohn focusses on: +ONAP 'Kohn' focusses on: - Further O-RAN integration with A1 and O1 policy control for SON use cases - improved flows for Cloud-Native Network Functions (CNF) orchestration and diff --git a/docs/security/index.rst b/docs/security/index.rst index 2679de86c..f0814c401 100644 --- a/docs/security/index.rst +++ b/docs/security/index.rst @@ -3,8 +3,8 @@ .. _onap-security-index: -ONAP Security -============= +Vulnerabilities and Advisories +============================== Reporting Vulnerabilities ------------------------- -- 2.16.6