summaryrefslogtreecommitdiffstats
path: root/docs/templates/sections/configuration.rst
diff options
context:
space:
mode:
authorRich Bennett <rb2745@att.com>2017-10-10 07:39:06 -0400
committerRich Bennett <rb2745@att.com>2017-10-10 07:44:50 -0400
commit7134cba7aa509a5ee7628244c52979e02807d252 (patch)
tree01d4f737b6c3b27515bd8f116850f838b7cc6830 /docs/templates/sections/configuration.rst
parent2f3328219820a4be426981282350034b21e2e3f3 (diff)
Improve templates and add references in guides
See description of DOC-101 Added multipple conf.py files to test themes and multiple versions Created initial structure for references in developer architecture guide and release notes Change-Id: I7affcd1cb0258bef7cebe357a938080abe419693 Issue-ID: DOC-101 Signed-off-by: Rich Bennett <rb2745@att.com>
Diffstat (limited to 'docs/templates/sections/configuration.rst')
-rw-r--r--docs/templates/sections/configuration.rst27
1 files changed, 27 insertions, 0 deletions
diff --git a/docs/templates/sections/configuration.rst b/docs/templates/sections/configuration.rst
new file mode 100644
index 000000000..085f9c667
--- /dev/null
+++ b/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``