summaryrefslogtreecommitdiffstats
path: root/docs/guides/onap-developer/how-to-use-docs/templates
diff options
context:
space:
mode:
Diffstat (limited to 'docs/guides/onap-developer/how-to-use-docs/templates')
-rw-r--r--docs/guides/onap-developer/how-to-use-docs/templates/collections/platform-component.rst23
-rw-r--r--docs/guides/onap-developer/how-to-use-docs/templates/collections/sdk.rst17
-rw-r--r--docs/guides/onap-developer/how-to-use-docs/templates/sections/administration.rst24
-rw-r--r--docs/guides/onap-developer/how-to-use-docs/templates/sections/architecture.rst27
-rw-r--r--docs/guides/onap-developer/how-to-use-docs/templates/sections/build.rst23
-rw-r--r--docs/guides/onap-developer/how-to-use-docs/templates/sections/configuration.rst27
-rw-r--r--docs/guides/onap-developer/how-to-use-docs/templates/sections/consumedapis.rst16
-rw-r--r--docs/guides/onap-developer/how-to-use-docs/templates/sections/delivery.rst44
-rw-r--r--docs/guides/onap-developer/how-to-use-docs/templates/sections/design.rst13
-rw-r--r--docs/guides/onap-developer/how-to-use-docs/templates/sections/humaninterfaces.rst17
-rw-r--r--docs/guides/onap-developer/how-to-use-docs/templates/sections/installation.rst20
-rw-r--r--docs/guides/onap-developer/how-to-use-docs/templates/sections/logging.rst22
-rw-r--r--docs/guides/onap-developer/how-to-use-docs/templates/sections/offeredapis.rst14
-rw-r--r--docs/guides/onap-developer/how-to-use-docs/templates/sections/release-notes.rst127
14 files changed, 414 insertions, 0 deletions
diff --git a/docs/guides/onap-developer/how-to-use-docs/templates/collections/platform-component.rst b/docs/guides/onap-developer/how-to-use-docs/templates/collections/platform-component.rst
new file mode 100644
index 000000000..3cde22948
--- /dev/null
+++ b/docs/guides/onap-developer/how-to-use-docs/templates/collections/platform-component.rst
@@ -0,0 +1,23 @@
+.. 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/design.rst
+ ../sections/logging.rst
+ ../sections/installation.rst
+ ../sections/configuration.rst
+ ../sections/administration.rst
+ ../sections/humaninterfaces.rst
+ ../sections/release-notes.rst
diff --git a/docs/guides/onap-developer/how-to-use-docs/templates/collections/sdk.rst b/docs/guides/onap-developer/how-to-use-docs/templates/collections/sdk.rst
new file mode 100644
index 000000000..83fbbe2ee
--- /dev/null
+++ b/docs/guides/onap-developer/how-to-use-docs/templates/collections/sdk.rst
@@ -0,0 +1,17 @@
+.. 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/guides/onap-developer/how-to-use-docs/templates/sections/administration.rst b/docs/guides/onap-developer/how-to-use-docs/templates/sections/administration.rst
new file mode 100644
index 000000000..94a740718
--- /dev/null
+++ b/docs/guides/onap-developer/how-to-use-docs/templates/sections/administration.rst
@@ -0,0 +1,24 @@
+.. 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/guides/onap-developer/how-to-use-docs/templates/sections/architecture.rst b/docs/guides/onap-developer/how-to-use-docs/templates/sections/architecture.rst
new file mode 100644
index 000000000..8daa0d3bc
--- /dev/null
+++ b/docs/guides/onap-developer/how-to-use-docs/templates/sections/architecture.rst
@@ -0,0 +1,27 @@
+.. 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/guides/onap-developer/how-to-use-docs/templates/sections/build.rst b/docs/guides/onap-developer/how-to-use-docs/templates/sections/build.rst
new file mode 100644
index 000000000..99a061c24
--- /dev/null
+++ b/docs/guides/onap-developer/how-to-use-docs/templates/sections/build.rst
@@ -0,0 +1,23 @@
+.. 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/guides/onap-developer/how-to-use-docs/templates/sections/configuration.rst b/docs/guides/onap-developer/how-to-use-docs/templates/sections/configuration.rst
new file mode 100644
index 000000000..085f9c667
--- /dev/null
+++ b/docs/guides/onap-developer/how-to-use-docs/templates/sections/configuration.rst
@@ -0,0 +1,27 @@
+.. 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/guides/onap-developer/how-to-use-docs/templates/sections/consumedapis.rst b/docs/guides/onap-developer/how-to-use-docs/templates/sections/consumedapis.rst
new file mode 100644
index 000000000..c2af4c20e
--- /dev/null
+++ b/docs/guides/onap-developer/how-to-use-docs/templates/sections/consumedapis.rst
@@ -0,0 +1,16 @@
+.. 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/guides/onap-developer/how-to-use-docs/templates/sections/delivery.rst b/docs/guides/onap-developer/how-to-use-docs/templates/sections/delivery.rst
new file mode 100644
index 000000000..f3f083a73
--- /dev/null
+++ b/docs/guides/onap-developer/how-to-use-docs/templates/sections/delivery.rst
@@ -0,0 +1,44 @@
+.. 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/guides/onap-developer/how-to-use-docs/templates/sections/design.rst b/docs/guides/onap-developer/how-to-use-docs/templates/sections/design.rst
new file mode 100644
index 000000000..f173a2fb5
--- /dev/null
+++ b/docs/guides/onap-developer/how-to-use-docs/templates/sections/design.rst
@@ -0,0 +1,13 @@
+.. 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/guides/onap-developer/how-to-use-docs/templates/sections/humaninterfaces.rst b/docs/guides/onap-developer/how-to-use-docs/templates/sections/humaninterfaces.rst
new file mode 100644
index 000000000..429284608
--- /dev/null
+++ b/docs/guides/onap-developer/how-to-use-docs/templates/sections/humaninterfaces.rst
@@ -0,0 +1,17 @@
+.. 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/guides/onap-developer/how-to-use-docs/templates/sections/installation.rst b/docs/guides/onap-developer/how-to-use-docs/templates/sections/installation.rst
new file mode 100644
index 000000000..be64a63bb
--- /dev/null
+++ b/docs/guides/onap-developer/how-to-use-docs/templates/sections/installation.rst
@@ -0,0 +1,20 @@
+.. 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/guides/onap-developer/how-to-use-docs/templates/sections/logging.rst b/docs/guides/onap-developer/how-to-use-docs/templates/sections/logging.rst
new file mode 100644
index 000000000..39eabfba7
--- /dev/null
+++ b/docs/guides/onap-developer/how-to-use-docs/templates/sections/logging.rst
@@ -0,0 +1,22 @@
+.. 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/guides/onap-developer/how-to-use-docs/templates/sections/offeredapis.rst b/docs/guides/onap-developer/how-to-use-docs/templates/sections/offeredapis.rst
new file mode 100644
index 000000000..23504c1da
--- /dev/null
+++ b/docs/guides/onap-developer/how-to-use-docs/templates/sections/offeredapis.rst
@@ -0,0 +1,14 @@
+.. 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/guides/onap-developer/how-to-use-docs/templates/sections/release-notes.rst b/docs/guides/onap-developer/how-to-use-docs/templates/sections/release-notes.rst
new file mode 100644
index 000000000..11f38fed9
--- /dev/null
+++ b/docs/guides/onap-developer/how-to-use-docs/templates/sections/release-notes.rst
@@ -0,0 +1,127 @@
+.. 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> |
+| | |
++--------------------------------------+--------------------------------------+
+
+
+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