aboutsummaryrefslogtreecommitdiffstats
path: root/docs/configuration.rst
diff options
context:
space:
mode:
authorTschaen, Brendan <ctschaen@att.com>2018-10-16 20:22:35 -0400
committerTschaen, Brendan <ctschaen@att.com>2018-10-16 20:27:37 -0400
commit46350c084766789ea59e83f1917c57c81d653048 (patch)
tree3463279fcee9c26d190d854324bbd7f86422fe2e /docs/configuration.rst
parent287bdcbb5482f94df091c3b7b766fed0007efa2e (diff)
Include Cassandra locking
Change-Id: I085acf8336d5f27782ee12768846a5befd3ee60d Issue-ID: MUSIC-148 Signed-off-by: Tschaen, Brendan <ctschaen@att.com>
Diffstat (limited to 'docs/configuration.rst')
-rw-r--r--docs/configuration.rst27
1 files changed, 13 insertions, 14 deletions
diff --git a/docs/configuration.rst b/docs/configuration.rst
index 279e5bd6..085f9c66 100644
--- a/docs/configuration.rst
+++ b/docs/configuration.rst
@@ -4,25 +4,24 @@
Configuration
=============
-See the following pages for Configuration Information:
+.. note::
+ * This section is used to describe the options a software component offers for configuration.
-.. toctree::
- :maxdepth: 1
+ * 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.
- Single-Site Install <single>
- Multi-Site Install <multi>
- Authentication <authentication>
+Example ...
-.. Example ...
+You can provide the following in ``basic.conf``
-.. You can provide the following in ``basic.conf``
+``host=ADDRESS``
+ The address of the host
-.. ``host=ADDRESS``
-.. The address of the host
+``port=PORT``
+ The port used for signaling
-.. ``port=PORT``
-.. The port used for signaling
-
-.. Optional. Default: ``8080``
+ Optional. Default: ``8080``