aboutsummaryrefslogtreecommitdiffstats
path: root/sdnr/wt/helpserver/provider/README.md
diff options
context:
space:
mode:
authorHerbert Eiselt <herbert.eiselt@highstreet-technologies.com>2019-03-29 10:53:28 +0100
committerHerbert Eiselt <herbert.eiselt@highstreet-technologies.com>2019-03-29 10:54:18 +0100
commite26f1bfa9bdad0562b9d0be226e8b7fa756c7345 (patch)
tree3e8cea63e6e3e2aa85510ec5df6682e6f99aca56 /sdnr/wt/helpserver/provider/README.md
parentf2bb490d9c82decbdb50c1e4db1be2f34b28d097 (diff)
SDNR prepare for readthedocs
Adjust helpserver to generate help content Change-Id: I913615019d1415d88942b8d2050ed39e55e1dc2e Issue-ID: SDNC-716 Signed-off-by: Herbert Eiselt <herbert.eiselt@highstreet-technologies.com>
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