Skip to content

Commit

Permalink
improve use cases entry page
Browse files Browse the repository at this point in the history
Issue-ID: DOC-811

Signed-off-by: thmsdt <[email protected]>
Change-Id: I492a59cdf270e261135c57d26e39f2b3bee402c8
  • Loading branch information
thmsdt committed Mar 9, 2023
1 parent 55fca95 commit 317e6bd
Show file tree
Hide file tree
Showing 3 changed files with 46 additions and 25 deletions.
6 changes: 6 additions & 0 deletions docs/_static/bullseye.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
16 changes: 16 additions & 0 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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>`
--------------------------

Expand Down
49 changes: 24 additions & 25 deletions docs/usecases/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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>`

0 comments on commit 317e6bd

Please sign in to comment.