summaryrefslogtreecommitdiffstats
path: root/docs/templates/component-info/index.rst
diff options
context:
space:
mode:
authorRich Bennett <rb2745@att.com>2017-08-24 12:11:36 -0400
committerRich Bennett <rb2745@att.com>2017-08-24 16:44:10 +0000
commit1da304689093f1144d2be5cfb1fac6f29a158caa (patch)
tree36d5ceebd14c9ca5a6e6c854f52090bc72741c67 /docs/templates/component-info/index.rst
parent30b6487daa4c3a47ffa8fd290f46c261920f4201 (diff)
Update How To Guide & Git submodules
vnfrqts/requirements master advanced beyond submodule reference in doc before verify job available updated git reference to current level Improvements in the how to guide describing submodule integration Updated sphinx configuration to support sequence diagrams Temporary exclusion filter reduced for seed documents with severe errors Issue-Id: VNFRQTS-76 Change-Id: I3928a3d1e55a0731125e07186d8041b1614c3c8d Signed-off-by: Rich Bennett <rb2745@att.com>
Diffstat (limited to 'docs/templates/component-info/index.rst')
-rw-r--r--docs/templates/component-info/index.rst25
1 files changed, 25 insertions, 0 deletions
diff --git a/docs/templates/component-info/index.rst b/docs/templates/component-info/index.rst
index 11fa2f214..dfcfc747e 100644
--- a/docs/templates/component-info/index.rst
+++ b/docs/templates/component-info/index.rst
@@ -63,3 +63,28 @@ Consumed APIs
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.
+
+
+