aboutsummaryrefslogtreecommitdiffstats
path: root/sdnr/wt/helpserver/provider/README.md
diff options
context:
space:
mode:
authorDan Timoney <dtimoney@att.com>2019-03-29 12:59:06 +0000
committerGerrit Code Review <gerrit@onap.org>2019-03-29 12:59:06 +0000
commite6f319474636b5a7834eb6c74d02609da3d8a411 (patch)
tree27b1370e8411217d69cc45bfc065ca954255b218 /sdnr/wt/helpserver/provider/README.md
parent0d1d90903b6fd31669cf462f7cfd27703d4a84ed (diff)
parente26f1bfa9bdad0562b9d0be226e8b7fa756c7345 (diff)
Merge "SDNR prepare for readthedocs"
Diffstat (limited to 'sdnr/wt/helpserver/provider/README.md')
-rw-r--r--sdnr/wt/helpserver/provider/README.md34
1 files changed, 34 insertions, 0 deletions
diff --git a/sdnr/wt/helpserver/provider/README.md b/sdnr/wt/helpserver/provider/README.md
new file mode 100644
index 000000000..d35aeb580
--- /dev/null
+++ b/sdnr/wt/helpserver/provider/README.md
@@ -0,0 +1,34 @@
+##Creating help files
+
+#### Link and references to pictures.
+
+All links are relative to the current md-file.
+
+Link to pages located in the same directory:
+
+```
+[linkname](file.md)
+```
+
+Link to subpages located in subdirectories:
+
+```
+[linkname](subfolder/file.md)
+```
+
+External Links:
+
+```
+[linkname](linkurl "linktitle")
+```
+
+Images:
+
+```
+![SDN-R in ONAP](./ONAP-SDN-R.png "SDN-R in ONAP")
+```
+
+#### Supported formates
+
+md-format:
+Picture formats: PNG