diff options
| author |   Gregory Glover <gg2147@att.com> | 2017-10-10 12:18:00 +0000 |
|---|---|---|
| committer |   Gerrit Code Review <gerrit@onap.org> | 2017-10-10 12:18:00 +0000 |
| commit | 1f6cac44fa61db99bc530ca6513bfdccf3cc23e5 (patch) | |
| tree | aee05acd1b05789f1a34498a988d931eb53a5658 /docs/templates/sections/configuration.rst | |
| parent | f07646fc4b449d2e0fb14303c48f50b9e0c7d8e1 (diff) | |
| parent | 7134cba7aa509a5ee7628244c52979e02807d252 (diff) | |
Merge "Improve templates and add references in guides"
Diffstat (limited to 'docs/templates/sections/configuration.rst')
| -rw-r--r-- | docs/templates/sections/configuration.rst | 27 |
1 files changed, 27 insertions, 0 deletions
diff --git a/docs/templates/sections/configuration.rst b/docs/templates/sections/configuration.rst new file mode 100644 index 000000000..085f9c667 --- /dev/null +++ b/docs/templates/sections/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`` |