summaryrefslogtreecommitdiffstats
path: root/docs/sections/configuration.rst
diff options
context:
space:
mode:
authorBogumil Zebek <bogumil.zebek@nokia.com>2020-03-25 11:54:11 +0100
committerZebek Bogumil <bogumil.zebek@nokia.com>2020-03-26 10:17:56 +0100
commit483ccbf2d8f0c71ebb15a4a47246a68a42e68f3e (patch)
tree607a4bc00b06c380bd25a692f8710bde80fe83d8 /docs/sections/configuration.rst
parent9600d1361dd6e662248fe0704d1436ae56d446a7 (diff)
Documentation
Issue-ID: AAF-1091 Signed-off-by: Zebek Bogumil <bogumil.zebek@nokia.com> Change-Id: I59df0545c4dd5adfde32c83988f89cd2d0c4676b
Diffstat (limited to 'docs/sections/configuration.rst')
-rw-r--r--docs/sections/configuration.rst28
1 files changed, 28 insertions, 0 deletions
diff --git a/docs/sections/configuration.rst b/docs/sections/configuration.rst
new file mode 100644
index 00000000..47f2dd87
--- /dev/null
+++ b/docs/sections/configuration.rst
@@ -0,0 +1,28 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+.. Copyright 2020 NOKIA
+
+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``