summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorthmsdt <thomas.kulik@telekom.de>2023-03-09 13:24:31 +0100
committerthmsdt <thomas.kulik@telekom.de>2023-03-09 17:02:43 +0100
commit317e6bd4120c97fa961c8c62b4f7c8a52de0dc62 (patch)
tree3edbf221be6b14bef5eab12264cbf94ba6a2e5fe
parent55fca955305bb3a44c9aecc93a3e28ecae8a2ade (diff)
improve use cases entry page
Issue-ID: DOC-811 Signed-off-by: thmsdt <thomas.kulik@telekom.de> Change-Id: I492a59cdf270e261135c57d26e39f2b3bee402c8
-rw-r--r--docs/_static/bullseye.svg6
-rw-r--r--docs/index.rst16
-rw-r--r--docs/usecases/index.rst49
3 files changed, 46 insertions, 25 deletions
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 @@
+<svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" fill="currentColor" class="bi bi-bullseye" viewBox="0 0 16 16">
+ <path d="M8 15A7 7 0 1 1 8 1a7 7 0 0 1 0 14zm0 1A8 8 0 1 0 8 0a8 8 0 0 0 0 16z"/>
+ <path d="M8 13A5 5 0 1 1 8 3a5 5 0 0 1 0 10zm0 1A6 6 0 1 0 8 2a6 6 0 0 0 0 12z"/>
+ <path d="M8 11a3 3 0 1 1 0-6 3 3 0 0 1 0 6zm0 1a4 4 0 1 0 0-8 4 4 0 0 0 0 8z"/>
+ <path d="M9.5 8a1.5 1.5 0 1 1-3 0 1.5 1.5 0 0 1 3 0z"/>
+</svg> \ 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 <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>`
--------------------------
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<onap-integration:usecases/release_usecases>`
-* :doc:`Automated Use Cases<onap-integration:usecases/release_automated_usecases>`
-* :doc:`Functional Requirements<onap-integration:usecases/release_requirements>`
-* :doc:`Non Functional Requirements<onap-integration:usecases/release_non_functional_requirements>`
-* :doc:`Deprecated Use Cases and Functional Requirements<onap-integration:usecases/deprecated_usecases>`
+.. _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.<onap-integration:docs_usecases_release>`