diff options
| author |   Ofir Sonsino <os0695@att.com> | 2017-10-24 10:18:23 +0300 |
|---|---|---|
| committer | Ofir Sonsino <os0695@att.com> | 2017-10-24 10:18:23 +0300 |
| commit | 49351d760fb64a9eb26a2a5a79aa4799d0696aef (patch) | |
| tree | cea2ead632a9c12d00c03309f39540cd4dcc9d3f /docs/docs-configuration.rst | |
| parent | c3f38b5abe20df0e8ab8455dcc9d0599aba75bfd (diff) | |
Update ReadTheDocs docs folder
Change-Id: Ib1bf76d20f7e80a9152eb28c122cc5b98be0b1c8
Issue-ID: VID-71
Signed-off-by: Ofir Sonsino <os0695@att.com>
Diffstat (limited to 'docs/docs-configuration.rst')
| -rw-r--r-- | docs/docs-configuration.rst | 27 |
1 files changed, 27 insertions, 0 deletions
diff --git a/docs/docs-configuration.rst b/docs/docs-configuration.rst new file mode 100644 index 000000000..085f9c667 --- /dev/null +++ b/docs/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`` |