X-Git-Url: https://gerrit.onap.org/r/gitweb?a=blobdiff_plain;f=docs%2Ftemplates%2Fcomponent-info%2Findex.rst;h=dfcfc747e6e6037400537aec26ce8f2bd1136814;hb=1da304689093f1144d2be5cfb1fac6f29a158caa;hp=e438da8e0a6c1fdc33b040879ab8ff1b6fc6527e;hpb=9f0875c33d54bf716b18e2ab5d674a77463bdad1;p=doc.git diff --git a/docs/templates/component-info/index.rst b/docs/templates/component-info/index.rst index e438da8e0..dfcfc747e 100644 --- a/docs/templates/component-info/index.rst +++ b/docs/templates/component-info/index.rst @@ -1,8 +1,8 @@ .. This work is licensed under a Creative Commons Attribution 4.0 International License. .. http://creativecommons.org/licenses/by/4.0 -XXXX Component Information -========================== +Component Information Template +============================== High level architecture, design, and packaging information for release planning and delivery. .. toctree:: @@ -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. + + +