aboutsummaryrefslogtreecommitdiffstats
path: root/docs/configuration.rst
diff options
context:
space:
mode:
authorDan Timoney <dtimoney@att.com>2017-10-12 09:18:24 -0400
committerDan Timoney <dtimoney@att.com>2017-10-12 09:18:24 -0400
commit470fa2bf8c8718cbe224156e041c9753a19a08bf (patch)
tree02e93a021054230e6c46a9afb6801f5002a0b7a8 /docs/configuration.rst
parent79b6224cd7d73c6739bfbd20b90ce5d37fb426e1 (diff)
Add readthedocs for sdnc/oam
Add readthedocs sections for sdnc/oam. Change-Id: I54b725947ef67b494388e919daccc08a7be7dc9b Issue-ID: SDNC-72 Signed-off-by: Dan Timoney <dtimoney@att.com> Former-commit-id: c79ea358129eac458c0515a9ba252f5989c45b4e
Diffstat (limited to 'docs/configuration.rst')
-rw-r--r--docs/configuration.rst27
1 files changed, 27 insertions, 0 deletions
diff --git a/docs/configuration.rst b/docs/configuration.rst
new file mode 100644
index 00000000..c6d382c1
--- /dev/null
+++ b/docs/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`` \ No newline at end of file