diff options
| author |   Andrea Visnyei <andrea.visnyei@nokia.com> | 2020-12-09 12:26:35 +0100 |
|---|---|---|
| committer |   Eric Debeau <eric.debeau@orange.com> | 2021-05-06 15:36:12 +0200 |
| commit | 32d2daf4c1c9a01c6cc6e9b4218b9f4d2650b8e8 (patch) | |
| tree | 037bd4cf5220935b9f405d3db64e9b5b5e01eafe /docs/guides/onap-developer/how-to-use-docs/templates/sections/design.rst | |
| parent | c7d15886be96f3036709bb0acc4beb7169e8eec1 (diff) | |
Template updates - sections
Instructions and examples added, notes commented out, review comments implemented
Add example.com in the linkcheck_ignore
Issue-ID: DOC-696
Change-Id: I8221ba6f2adce534ced7d8c06fbc7f23eef39efe
Signed-off-by: Andrea Visnyei <andrea.visnyei@nokia.com>
Diffstat (limited to 'docs/guides/onap-developer/how-to-use-docs/templates/sections/design.rst')
| -rw-r--r-- | docs/guides/onap-developer/how-to-use-docs/templates/sections/design.rst | 25 |
1 files changed, 22 insertions, 3 deletions
diff --git a/docs/guides/onap-developer/how-to-use-docs/templates/sections/design.rst b/docs/guides/onap-developer/how-to-use-docs/templates/sections/design.rst index f173a2fb5..66c5f3651 100644 --- a/docs/guides/onap-developer/how-to-use-docs/templates/sections/design.rst +++ b/docs/guides/onap-developer/how-to-use-docs/templates/sections/design.rst @@ -1,13 +1,32 @@ .. This work is licensed under a Creative Commons Attribution 4.0 International License. .. http://creativecommons.org/licenses/by/4.0 +.. Copyright 2021 ONAP contributors, Nokia Design ====== -.. note:: - * This section is used to describe the internal design structure of a software component. +.. + * This section is used to describe the internal design structure of a + software component. * This section is typically provided: for a platform-component and sdk; and referenced in developer guides. - * This note must be removed after content has been added. + +Design principles +----------------- + +.. + List the basic principles of the component and best practices, as well. + +Static design +------------- + +.. + Description of classes, objects, etc. + +Dynamic view +------------ + +.. + Communication/interaction of objects when implementing the use cases. |