summaryrefslogtreecommitdiffstats
path: root/docs/templates
diff options
context:
space:
mode:
Diffstat (limited to 'docs/templates')
-rw-r--r--docs/templates/component-info/consumed-apis.csv1
-rw-r--r--docs/templates/component-info/index.rst90
-rw-r--r--docs/templates/component-info/offered-apis.csv2
-rw-r--r--docs/templates/platform-component/administration.rst19
-rw-r--r--docs/templates/platform-component/configuration.rst19
-rw-r--r--docs/templates/platform-component/consumedapis.rst8
-rw-r--r--docs/templates/platform-component/delivery.rst31
-rw-r--r--docs/templates/platform-component/humaninterfaces.rst19
-rw-r--r--docs/templates/platform-component/index.rst19
-rw-r--r--docs/templates/platform-component/installation.rst14
-rw-r--r--docs/templates/platform-component/logging.rst14
-rw-r--r--docs/templates/platform-component/offeredapis.rst12
-rw-r--r--docs/templates/release-notes/bug-fixes.rst (renamed from docs/templates/index.rst)13
-rw-r--r--docs/templates/release-notes/deprecation-notes.rst5
-rw-r--r--docs/templates/release-notes/index.rst15
-rw-r--r--docs/templates/release-notes/known-issues.rst5
-rw-r--r--docs/templates/release-notes/new-features.rst5
-rw-r--r--docs/templates/release-notes/other.rst5
-rw-r--r--docs/templates/release-notes/security-issues.rst5
-rw-r--r--docs/templates/release-notes/upgrade-notes.rst5
-rw-r--r--docs/templates/sdk/build.rst7
-rw-r--r--docs/templates/sdk/index.rst15
-rw-r--r--docs/templates/sdk/interfaces.rst3
-rw-r--r--docs/templates/sdk/libraries.rst7
-rw-r--r--docs/templates/sdk/logging.rst14
-rw-r--r--docs/templates/sdk/offeredapis.rst12
26 files changed, 260 insertions, 104 deletions
diff --git a/docs/templates/component-info/consumed-apis.csv b/docs/templates/component-info/consumed-apis.csv
deleted file mode 100644
index 811d1755d..000000000
--- a/docs/templates/component-info/consumed-apis.csv
+++ /dev/null
@@ -1 +0,0 @@
-repo.subrepo.subrepo|API Reference
diff --git a/docs/templates/component-info/index.rst b/docs/templates/component-info/index.rst
deleted file mode 100644
index dfcfc747e..000000000
--- a/docs/templates/component-info/index.rst
+++ /dev/null
@@ -1,90 +0,0 @@
-.. This work is licensed under a Creative Commons Attribution 4.0 International License.
-.. http://creativecommons.org/licenses/by/4.0
-
-Component Information Template
-==============================
-High level architecture, design, and packaging information for release planning and delivery.
-
-.. toctree::
- :maxdepth: 1
-
-
-Delivery
---------
-Th package component is composed of the functional layers and packaged into run-time components as illustrated in the following diagrams.
-
-.. 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;
- }
-
- }
-
-
-Offered APIs
-------------
-
-.. csv-table::
- :header-rows: 0
- :header: "Container or Library", "API Reference", "Purpose", "Protocol", "Port", "TCP/UDP"
- :widths: 20, 25, 25, 10, 10, 10
- :delim: |
- :file: offered-apis.csv
-
-
-Consumed APIs
--------------
-
-.. csv-table::
- :header-rows: 0
- :header: "Project Repo/Group ID", "Container or Library Offering API"
- :widths: 30, 30
- :delim: |
- :file: consumed-apis.csv
-
-Logging & Diagnostic Information
---------------------------------
-Description of how to interact with and diagnose problems with the components in the run-time packaging.
-
-
-Installation
-------------
-Steps to Install
-
-
-Configuration
--------------
-Where are they provided?
-What are parameters and values?
-
-
-Administration
---------------
-
-How to run and manage the component.
-
-
-Human Interfaces
-----------------
-Basic info on the interface type, ports/protocols provided over, etc.
-
-
-
diff --git a/docs/templates/component-info/offered-apis.csv b/docs/templates/component-info/offered-apis.csv
deleted file mode 100644
index 6300998f6..000000000
--- a/docs/templates/component-info/offered-apis.csv
+++ /dev/null
@@ -1,2 +0,0 @@
-XXX Container|API Reference link|Create or Delete XYZ|xxx|9999|TCP
-YYY Library|API Reference link|Create or Delete XYZ|xxxx|xxxx|xxxx
diff --git a/docs/templates/platform-component/administration.rst b/docs/templates/platform-component/administration.rst
new file mode 100644
index 000000000..1d512cf02
--- /dev/null
+++ b/docs/templates/platform-component/administration.rst
@@ -0,0 +1,19 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+
+
+Administration
+--------------
+Describe expected changes and the processes and actions taken for each.
+
+
+Processes
++++++++++
+* Process 1
+* Process 2
+
+Actions
++++++++
+* Action X
+* Action Y
+
diff --git a/docs/templates/platform-component/configuration.rst b/docs/templates/platform-component/configuration.rst
new file mode 100644
index 000000000..c0c969f85
--- /dev/null
+++ b/docs/templates/platform-component/configuration.rst
@@ -0,0 +1,19 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+
+Configuration
+-------------
+Describe configurations how to provide parameters and value
+
+Basic Setup
++++++++++++
+
+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/platform-component/consumedapis.rst b/docs/templates/platform-component/consumedapis.rst
new file mode 100644
index 000000000..c4309cdb1
--- /dev/null
+++ b/docs/templates/platform-component/consumedapis.rst
@@ -0,0 +1,8 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+
+Consumed APIs
+=============
+References to APIs offered by other components
+
+
diff --git a/docs/templates/platform-component/delivery.rst b/docs/templates/platform-component/delivery.rst
new file mode 100644
index 000000000..cfcab0449
--- /dev/null
+++ b/docs/templates/platform-component/delivery.rst
@@ -0,0 +1,31 @@
+Delivery
+--------
+Describe how functions are packaged into run-time components.
+For some components a block diagram may be useful.
+
+.. 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/platform-component/humaninterfaces.rst b/docs/templates/platform-component/humaninterfaces.rst
new file mode 100644
index 000000000..03cc875ed
--- /dev/null
+++ b/docs/templates/platform-component/humaninterfaces.rst
@@ -0,0 +1,19 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+
+Human Interfaces
+----------------
+Provide info on the targeted user, interface types, ports/protocols to access, etc.
+
+Target Users
+++++++++++++
+
+Interface Type
+++++++++++++++
+
+Access
+++++++
+
+
+
+
diff --git a/docs/templates/platform-component/index.rst b/docs/templates/platform-component/index.rst
new file mode 100644
index 000000000..4364739ee
--- /dev/null
+++ b/docs/templates/platform-component/index.rst
@@ -0,0 +1,19 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+
+Platform Component
+==================
+Provide an overview of the ONAP Platform component capabilities here.
+Add or remove sections below as appropriate for the platform component.
+
+.. toctree::
+ :maxdepth: 2
+
+ delivery.rst
+ offeredapis.rst
+ consumedapis.rst
+ logging.rst
+ installation.rst
+ configuration.rst
+ administration.rst
+ humaninterfaces.rst
diff --git a/docs/templates/platform-component/installation.rst b/docs/templates/platform-component/installation.rst
new file mode 100644
index 000000000..3238236c4
--- /dev/null
+++ b/docs/templates/platform-component/installation.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
+
+Installation
+------------
+Describe the environment and steps to install.
+
+
+Environment
++++++++++++
+
+
+Steps
++++++
diff --git a/docs/templates/platform-component/logging.rst b/docs/templates/platform-component/logging.rst
new file mode 100644
index 000000000..8d480e283
--- /dev/null
+++ b/docs/templates/platform-component/logging.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
+
+Logging & Diagnostic Information
+--------------------------------
+Description of how to interact with and diagnose problems with the components
+as delivered.
+
+Where to Access Information
++++++++++++++++++++++++++++
+
+
+Error / Warning Messages
+++++++++++++++++++++++++
diff --git a/docs/templates/platform-component/offeredapis.rst b/docs/templates/platform-component/offeredapis.rst
new file mode 100644
index 000000000..3e3b5b3d0
--- /dev/null
+++ b/docs/templates/platform-component/offeredapis.rst
@@ -0,0 +1,12 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+
+
+Offered APIs
+============
+List APIs offered. One or more of the following examples may be appropriate.
+
+* java docs link
+* rest API swagger json definition displayed with sphinx directive .. swaggerv2doc:
+* a restructured text document
+
diff --git a/docs/templates/index.rst b/docs/templates/release-notes/bug-fixes.rst
index 0f920a4a3..ee4ff9faf 100644
--- a/docs/templates/index.rst
+++ b/docs/templates/release-notes/bug-fixes.rst
@@ -1,14 +1,5 @@
-
.. This work is licensed under a Creative Commons Attribution 4.0 International License.
-.. _templates:
-
-Templates
-=========
-
-.. toctree::
- :maxdepth: 1
- :glob:
-
- **/index
+Bug Fixes
+---------
diff --git a/docs/templates/release-notes/deprecation-notes.rst b/docs/templates/release-notes/deprecation-notes.rst
new file mode 100644
index 000000000..e954e8764
--- /dev/null
+++ b/docs/templates/release-notes/deprecation-notes.rst
@@ -0,0 +1,5 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+
+Deprecation Notes
+-----------------
+
diff --git a/docs/templates/release-notes/index.rst b/docs/templates/release-notes/index.rst
new file mode 100644
index 000000000..adc76f935
--- /dev/null
+++ b/docs/templates/release-notes/index.rst
@@ -0,0 +1,15 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+
+Release Notes
+=============
+
+.. toctree::
+ :maxdepth: 2
+
+ new-features.rst
+ bug-fixes.rst
+ known-issues.rst
+ security-issues.rst
+ upgrade-notes.rst
+ deprecation-notes.rst
+ other.rst
diff --git a/docs/templates/release-notes/known-issues.rst b/docs/templates/release-notes/known-issues.rst
new file mode 100644
index 000000000..01c93d124
--- /dev/null
+++ b/docs/templates/release-notes/known-issues.rst
@@ -0,0 +1,5 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+
+Known Issues
+------------
+
diff --git a/docs/templates/release-notes/new-features.rst b/docs/templates/release-notes/new-features.rst
new file mode 100644
index 000000000..ab86bb949
--- /dev/null
+++ b/docs/templates/release-notes/new-features.rst
@@ -0,0 +1,5 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+
+New Features
+------------
+
diff --git a/docs/templates/release-notes/other.rst b/docs/templates/release-notes/other.rst
new file mode 100644
index 000000000..2ce683b5b
--- /dev/null
+++ b/docs/templates/release-notes/other.rst
@@ -0,0 +1,5 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+
+Other
+-----
+
diff --git a/docs/templates/release-notes/security-issues.rst b/docs/templates/release-notes/security-issues.rst
new file mode 100644
index 000000000..96e1fe95e
--- /dev/null
+++ b/docs/templates/release-notes/security-issues.rst
@@ -0,0 +1,5 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+
+Security Issues
+---------------
+
diff --git a/docs/templates/release-notes/upgrade-notes.rst b/docs/templates/release-notes/upgrade-notes.rst
new file mode 100644
index 000000000..f31c74a69
--- /dev/null
+++ b/docs/templates/release-notes/upgrade-notes.rst
@@ -0,0 +1,5 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+
+Upgrade Notes
+-------------
+
diff --git a/docs/templates/sdk/build.rst b/docs/templates/sdk/build.rst
new file mode 100644
index 000000000..11f4ac537
--- /dev/null
+++ b/docs/templates/sdk/build.rst
@@ -0,0 +1,7 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+
+Building components that use the SDK
+------------------------------------
+
+
diff --git a/docs/templates/sdk/index.rst b/docs/templates/sdk/index.rst
new file mode 100644
index 000000000..8c31c9b58
--- /dev/null
+++ b/docs/templates/sdk/index.rst
@@ -0,0 +1,15 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+
+Software Development Kit
+========================
+Provide an overview of SDK capabilities here.
+
+.. toctree::
+ :maxdepth: 2
+
+ offeredapis.rst
+ libraries.rst
+ interfaces.rst
+ logging.rst
+ build.rst
diff --git a/docs/templates/sdk/interfaces.rst b/docs/templates/sdk/interfaces.rst
new file mode 100644
index 000000000..d28496fa2
--- /dev/null
+++ b/docs/templates/sdk/interfaces.rst
@@ -0,0 +1,3 @@
+Interfaces
+----------
+Language bindings
diff --git a/docs/templates/sdk/libraries.rst b/docs/templates/sdk/libraries.rst
new file mode 100644
index 000000000..36143660a
--- /dev/null
+++ b/docs/templates/sdk/libraries.rst
@@ -0,0 +1,7 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+
+Libraries
+---------
+Libraries provided including package/Nexus groupID names, language bindings, etc.
+
diff --git a/docs/templates/sdk/logging.rst b/docs/templates/sdk/logging.rst
new file mode 100644
index 000000000..8d480e283
--- /dev/null
+++ b/docs/templates/sdk/logging.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
+
+Logging & Diagnostic Information
+--------------------------------
+Description of how to interact with and diagnose problems with the components
+as delivered.
+
+Where to Access Information
++++++++++++++++++++++++++++
+
+
+Error / Warning Messages
+++++++++++++++++++++++++
diff --git a/docs/templates/sdk/offeredapis.rst b/docs/templates/sdk/offeredapis.rst
new file mode 100644
index 000000000..3e3b5b3d0
--- /dev/null
+++ b/docs/templates/sdk/offeredapis.rst
@@ -0,0 +1,12 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+
+
+Offered APIs
+============
+List APIs offered. One or more of the following examples may be appropriate.
+
+* java docs link
+* rest API swagger json definition displayed with sphinx directive .. swaggerv2doc:
+* a restructured text document
+