diff options
Diffstat (limited to 'docs/templates')
| -rw-r--r-- | docs/templates/collections/platform-component.rst | 22 | ||||
| -rw-r--r-- | docs/templates/collections/sdk.rst | 17 | ||||
| -rw-r--r-- | docs/templates/sections/administration.rst | 24 | ||||
| -rw-r--r-- | docs/templates/sections/architecture.rst | 27 | ||||
| -rw-r--r-- | docs/templates/sections/build.rst | 23 | ||||
| -rw-r--r-- | docs/templates/sections/configuration.rst | 27 | ||||
| -rw-r--r-- | docs/templates/sections/consumedapis.rst | 16 | ||||
| -rw-r--r-- | docs/templates/sections/delivery.rst | 44 | ||||
| -rw-r--r-- | docs/templates/sections/design.rst | 13 | ||||
| -rw-r--r-- | docs/templates/sections/humaninterfaces.rst | 17 | ||||
| -rw-r--r-- | docs/templates/sections/installation.rst | 20 | ||||
| -rw-r--r-- | docs/templates/sections/logging.rst | 22 | ||||
| -rw-r--r-- | docs/templates/sections/offeredapis.rst | 14 | ||||
| -rw-r--r-- | docs/templates/sections/release-notes.rst | 129 | ||||
| -rw-r--r-- | docs/templates/sections/vnf-reference.rst | 29 |
15 files changed, 0 insertions, 444 deletions
diff --git a/docs/templates/collections/platform-component.rst b/docs/templates/collections/platform-component.rst deleted file mode 100644 index 98119aca5..000000000 --- a/docs/templates/collections/platform-component.rst +++ /dev/null @@ -1,22 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 - - -Platform Component -================== - -.. Add or remove sections below as appropriate for the platform component. - -.. toctree:: - :maxdepth: 1 - - ../sections/architecture.rst - ../sections/offeredapis.rst - ../sections/consumedapis.rst - ../sections/delivery.rst - ../sections/logging.rst - ../sections/installation.rst - ../sections/configuration.rst - ../sections/administration.rst - ../sections/humaninterfaces.rst - ../sections/release-notes.rst diff --git a/docs/templates/collections/sdk.rst b/docs/templates/collections/sdk.rst deleted file mode 100644 index 83fbbe2ee..000000000 --- a/docs/templates/collections/sdk.rst +++ /dev/null @@ -1,17 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 - -SDK -=== - -.. Add or remove sections below as appropriate for the SDK - -.. toctree:: - :maxdepth: 1 - - ../sections/architecture.rst - ../sections/offeredapis.rst - ../sections/delivery.rst - ../sections/logging.rst - ../sections/build.rst - ../sections/release-notes.rst diff --git a/docs/templates/sections/administration.rst b/docs/templates/sections/administration.rst deleted file mode 100644 index 94a740718..000000000 --- a/docs/templates/sections/administration.rst +++ /dev/null @@ -1,24 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 - -Administration -============== - - -.. note:: - * This section is used to describe a software component from the perspective of on-going - operation including regular processes and actions that are taken to configure and manage - the component. - - * This section is typically: provided for platform-component or applications; and - referenced in user guides - - * This note must be removed after content has been added. - - -Processes ---------- - - -Actions -------- diff --git a/docs/templates/sections/architecture.rst b/docs/templates/sections/architecture.rst deleted file mode 100644 index 8daa0d3bc..000000000 --- a/docs/templates/sections/architecture.rst +++ /dev/null @@ -1,27 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 - -Architecture -============ - -.. note:: - * This section is used to describe a software component from a high level - view of capability, common usage scenarios, and interactions with other - components required in the usage scenarios. - - * The architecture section is typically: provided in a platform-component - and sdk collections; and referenced from developer and user guides. - - * This note must be removed after content has been added. - - -Capabilities ------------- - - -Usage Scenarios ---------------- - - -Interactions ------------- diff --git a/docs/templates/sections/build.rst b/docs/templates/sections/build.rst deleted file mode 100644 index 99a061c24..000000000 --- a/docs/templates/sections/build.rst +++ /dev/null @@ -1,23 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 - -Build -===== - -.. note:: - * This section is used to describe how a software component is built from source - into something ready for use either in a run-time environment or to build other - components. - - * This section is typically provided for a platform-component, application, and sdk; and - referenced in developer guides. - - * This note must be removed after content has been added. - - -Environment ------------ - - -Steps ------ diff --git a/docs/templates/sections/configuration.rst b/docs/templates/sections/configuration.rst deleted file mode 100644 index 085f9c667..000000000 --- a/docs/templates/sections/configuration.rst +++ /dev/null @@ -1,27 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 - -Configuration -============= - -.. note:: - * This section is used to describe the options a software component offers for configuration. - - * Configuration is typically: provided for platform-component and sdk projects; - and referenced in developer and user guides. - - * This note must be removed after content has been added. - - - -Example ... - -You can provide the following in ``basic.conf`` - -``host=ADDRESS`` - The address of the host - -``port=PORT`` - The port used for signaling - - Optional. Default: ``8080`` diff --git a/docs/templates/sections/consumedapis.rst b/docs/templates/sections/consumedapis.rst deleted file mode 100644 index c2af4c20e..000000000 --- a/docs/templates/sections/consumedapis.rst +++ /dev/null @@ -1,16 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 - -Consumed APIs -============= - -.. note:: - * This section is used to reference APIs that a software component depends on - and uses from other sources. - - * Consumed APIs should be a specific link to the offered APIs from another component - or external source. - - * This note must be removed after content has been added. - - diff --git a/docs/templates/sections/delivery.rst b/docs/templates/sections/delivery.rst deleted file mode 100644 index f3f083a73..000000000 --- a/docs/templates/sections/delivery.rst +++ /dev/null @@ -1,44 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 - -Delivery -======== - -.. note:: - * This section is used to describe a software component packaging. - For a run-time component this might be executable images, containers, etc. - For an SDK this might be libraries. - - * This section is typically provided for a platform-component and sdk; - and referenced in developer and user guides - - * This note must be removed after content has been added. - -Example use of a block diagram. - -.. blockdiag:: - - - blockdiag layers { - orientation = portrait - a -> m; - b -> n; - c -> x; - m -> y; - m -> z; - group l1 { - color = blue; - x; y; z; - } - group l2 { - color = yellow; - m; n; - } - group l3 { - color = orange; - a; b; c; - } - - } - - diff --git a/docs/templates/sections/design.rst b/docs/templates/sections/design.rst deleted file mode 100644 index f173a2fb5..000000000 --- a/docs/templates/sections/design.rst +++ /dev/null @@ -1,13 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 - -Design -====== - -.. note:: - * 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. diff --git a/docs/templates/sections/humaninterfaces.rst b/docs/templates/sections/humaninterfaces.rst deleted file mode 100644 index 429284608..000000000 --- a/docs/templates/sections/humaninterfaces.rst +++ /dev/null @@ -1,17 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 - -Human Interfaces -================ - -.. note:: - * This section is used to describe a software component's command line and graphical - user interfaces. - - * This section is typically: provided for a platform-component and application; and - referenced from user guides. - - * This note must be removed after content has been added. - - - diff --git a/docs/templates/sections/installation.rst b/docs/templates/sections/installation.rst deleted file mode 100644 index be64a63bb..000000000 --- a/docs/templates/sections/installation.rst +++ /dev/null @@ -1,20 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 - -Installation -============ - -.. note:: - * This section is used to describe how a software component is acquired and installed. - - * This section is typically: provided for a platform-component and application; and - referenced in user guides. - - * This note must be removed after content has been added. - -Environment ------------ - - -Steps ------ diff --git a/docs/templates/sections/logging.rst b/docs/templates/sections/logging.rst deleted file mode 100644 index 39eabfba7..000000000 --- a/docs/templates/sections/logging.rst +++ /dev/null @@ -1,22 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 - -Logging -======= - -.. note:: - * This section is used to describe the informational or diagnostic messages emitted from - a software component and the methods or collecting them. - - * This section is typically: provided for a platform-component and sdk; and - referenced in developer and user guides - - * This note must be removed after content has been added. - - -Where to Access Information ---------------------------- - - -Error / Warning Messages ------------------------- diff --git a/docs/templates/sections/offeredapis.rst b/docs/templates/sections/offeredapis.rst deleted file mode 100644 index 23504c1da..000000000 --- a/docs/templates/sections/offeredapis.rst +++ /dev/null @@ -1,14 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 - -Offered APIs -============ - -.. note:: - * This section is used to describe the external interfaces offered by a software component - - * This section is typically: provided for a platform-component and sdk; and - referenced in developer guides and api reference manuals. - - * This note must be removed after content has been added. - diff --git a/docs/templates/sections/release-notes.rst b/docs/templates/sections/release-notes.rst deleted file mode 100644 index 99eb015f2..000000000 --- a/docs/templates/sections/release-notes.rst +++ /dev/null @@ -1,129 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 - International License. -.. http://creativecommons.org/licenses/by/4.0 -.. (c) ONAP Project and its contributors -.. _release_notes: - -*********************** -<project> Release Notes -*********************** - -.. note:: - * The release note needs to be updated for each ONAP release - * Except the section "Release data" all other sections are optional and should be - applied where applicable - * Only the current release is to be documented in this document - * This note needs to be removed before publishing the final result - -Abstract -======== - -This document provides the release notes for the ``<releasename>`` release. - -Summary -======= - -<Give a high level description of your project with regards to this -specific release> - - -Release Data -============ - -+--------------------------------------+--------------------------------------+ -| **Project** | <project name> | -| | | -+--------------------------------------+--------------------------------------+ -| **Docker images** | make sure you include all docker | -| | images including the | -| | release version | -| | | -+--------------------------------------+--------------------------------------+ -| **Release designation** | <release name followed by version> | -| | | -+--------------------------------------+--------------------------------------+ -| **Release date** | <DD/MM/YYYY> | -| | | -+--------------------------------------+--------------------------------------+ - -New features ------------- - -<Describe new features or other new additions> - -**Bug fixes** - -- `CIMAN-65 <https://jira.onap.org/browse/CIMAN-65>`_ and a sentence explaining - what this defect is addressing. - -**Known Issues** - -- `CIMAN-65 <https://jira.onap.org/browse/CIMAN-65>`_ and two to three sentences - explaining what this issue is. - -Deliverables ------------- - -Software Deliverables -~~~~~~~~~~~~~~~~~~~~~ - - -Documentation Deliverables -~~~~~~~~~~~~~~~~~~~~~~~~~~ - - -Known Limitations, Issues and Workarounds -========================================= - -System Limitations ------------------- - -Any known system limitations. - - -Known Vulnerabilities ---------------------- - -Results of know vulnerabilities analysis in used modules. - - -Workarounds ------------ - -Any known workarounds. - - -Security Notes --------------- - -**Fixed Security Issues** - -List of security issues fixed in this release including CVEs and OJSI -tickets. - -**Known Security Issues** - -List of new security issues that are left unfixed in this release including -CVEs and OJSI tickets. - - -Test Results -============ -List or refer to any project specific results - - -References -========== - -For more information on the ONAP ``<release name>`` release, please see: - -#. `ONAP Home Page`_ -#. `ONAP Documentation`_ -#. `ONAP Release Downloads`_ -#. `ONAP Wiki Page`_ - - -.. _`ONAP Home Page`: https://www.onap.org -.. _`ONAP Wiki Page`: https://wiki.onap.org -.. _`ONAP Documentation`: https://docs.onap.org -.. _`ONAP Release Downloads`: https://git.onap.org diff --git a/docs/templates/sections/vnf-reference.rst b/docs/templates/sections/vnf-reference.rst deleted file mode 100644 index 165eee530..000000000 --- a/docs/templates/sections/vnf-reference.rst +++ /dev/null @@ -1,29 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 - -VNF -=== - -.. note:: - * This section is used to describe Virtual Network Function software - - * This section is typically provided: as additional detail on use cases, - to illustrate end to end platform architecture, and to describe - compliance with ONAP VNF requirements. - - * The VNF Heading above should be replaced with the VNF NAME - - * This note must be removed after content has been added. - -Version -------- - -User Documentation ------------------- - -Source ------- - -ONAP VNF Requirements Compliance --------------------------------- - |