summaryrefslogtreecommitdiffstats
path: root/docs/guides/onap-developer/how-to-use-docs/templates/sections/configuration.rst
diff options
context:
space:
mode:
authorEric Debeau <eric.debeau@orange.com>2020-11-30 15:32:31 +0100
committerEric Debeau <eric.debeau@orange.com>2020-11-30 15:32:31 +0100
commitab0c78bb275b345eb5e995a40a90e633980d7bca (patch)
treed27e73c14d4fcb22ccaac37341dfd494630f2c8a /docs/guides/onap-developer/how-to-use-docs/templates/sections/configuration.rst
parentf60c4279e12ba862fee20afdbff4a2d586a458cc (diff)
Remove all warnings during Documentation buildings
Remove files with not links: - guides/onap-developer/architecture/blueprint-enr.rst old file based on Beijing - smsummary.rst: no more relevant as no more submodules used - templates/sections/vnf-reference.rst : not referenced - guides/onap-user/onapportal.rst: redundant - guides/onap-developer/tutorials/index.rst: no tutorial Add new files to inlude templates Move templates directory under how-to-use-docs Modify global release not label with onap_release_notes to avoid confusion Issue-ID: DOC-692 Signed-off-by: Eric Debeau <eric.debeau@orange.com> Change-Id: I709765beb02403c4ad058863c2b5136f42968cff
Diffstat (limited to 'docs/guides/onap-developer/how-to-use-docs/templates/sections/configuration.rst')
-rw-r--r--docs/guides/onap-developer/how-to-use-docs/templates/sections/configuration.rst27
1 files changed, 27 insertions, 0 deletions
diff --git a/docs/guides/onap-developer/how-to-use-docs/templates/sections/configuration.rst b/docs/guides/onap-developer/how-to-use-docs/templates/sections/configuration.rst
new file mode 100644
index 000000000..085f9c667
--- /dev/null
+++ b/docs/guides/onap-developer/how-to-use-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``