From 4b00193d6ad8fcc99c5625ede8de07b72ae1c697 Mon Sep 17 00:00:00 2001 From: Rich Bennett Date: Mon, 16 Oct 2017 09:25:01 -0400 Subject: Update toctree to current release notes template Change-Id: I0864d9e3c46aae885473a18fa21eab205a352eff Issue-ID: SDC-419 Signed-off-by: Rich Bennett --- docs/configuration.rst | 27 +++++++++++++++++++++++++++ 1 file changed, 27 insertions(+) create mode 100644 docs/configuration.rst (limited to 'docs/configuration.rst') diff --git a/docs/configuration.rst b/docs/configuration.rst new file mode 100644 index 0000000000..085f9c667d --- /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`` -- cgit 1.2.3-korg