From 317e6bd4120c97fa961c8c62b4f7c8a52de0dc62 Mon Sep 17 00:00:00 2001 From: thmsdt Date: Thu, 9 Mar 2023 13:24:31 +0100 Subject: [PATCH] improve use cases entry page Issue-ID: DOC-811 Signed-off-by: thmsdt Change-Id: I492a59cdf270e261135c57d26e39f2b3bee402c8 --- docs/_static/bullseye.svg | 6 ++++++ docs/index.rst | 16 ++++++++++++++++ docs/usecases/index.rst | 49 +++++++++++++++++++++++------------------------ 3 files changed, 46 insertions(+), 25 deletions(-) create mode 100644 docs/_static/bullseye.svg diff --git a/docs/_static/bullseye.svg b/docs/_static/bullseye.svg new file mode 100644 index 000000000..85a807cee --- /dev/null +++ b/docs/_static/bullseye.svg @@ -0,0 +1,6 @@ + + + + + + \ No newline at end of file diff --git a/docs/index.rst b/docs/index.rst index 1bc85ca96..df86f098e 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -82,6 +82,22 @@ Names and release dates of previous ONAP versions. ------------------------------------------------------------------------------- +:ref:`Use Cases, Blueprints, Requirements ` +----------------------------------------------------------- + +.. 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 ` -------------------------- diff --git a/docs/usecases/index.rst b/docs/usecases/index.rst index c1d8c8272..da837961b 100644 --- a/docs/usecases/index.rst +++ b/docs/usecases/index.rst @@ -2,28 +2,27 @@ .. International License. http://creativecommons.org/licenses/by/4.0 .. Copyright 2023 ONAP Contributors. All rights reserved. -.. _usecases: - -'Kohn' Use Cases and Requirements -================================= - - -The section includes use cases and functional requirements which have been -officially verified in the release. - -For each use case or functional requirement, you can find contact names and a -link to the associated documentation. - -This documentation deals with - - 1. What has been implemented - 2. Step by step instructions to deploy and execute the tests, including the - links to download the related assets and resources - 3. Known issues and workarounds - - -* :doc:`Release Use Cases` -* :doc:`Automated Use Cases` -* :doc:`Functional Requirements` -* :doc:`Non Functional Requirements` -* :doc:`Deprecated Use Cases and Functional Requirements` +.. _usecases_entry: + +Use Cases, Blueprints, Requirements +=================================== + +ONAP use cases are descriptions of how a user interacts with an ONAP system to +achieve a specific goal. They describe the actions that the user takes, the +system’s responses, and any conditions or tasks that must be met for the +interaction to occur. ONAP use cases are used to identify and define the +functional requirements of the ONAP system. + +ONAP requirements are statements that describe what the ONAP system must do, +how it should behave , and what constraints it must operate under. +ONAP requirements are typically divided into functional requirements, which +describe what the ONAP system must do, and non-functional requirements, which +describe how the ONAP system should behave or perform. + +ONAP blueprint is a high-level design document that provides an overview of the +ONAP system’s architecture and components. The blueprint typically includes +diagrams that illustrate the ONAP system’s structure and relationships between +components, as well as descriptions of each ONAP component’s function and +interface. + +:doc:`The latest verified use cases, functional requirements and blueprints can be found here.` -- 2.16.6