From e26f1bfa9bdad0562b9d0be226e8b7fa756c7345 Mon Sep 17 00:00:00 2001 From: Herbert Eiselt Date: Fri, 29 Mar 2019 10:53:28 +0100 Subject: SDNR prepare for readthedocs Adjust helpserver to generate help content Change-Id: I913615019d1415d88942b8d2050ed39e55e1dc2e Issue-ID: SDNC-716 Signed-off-by: Herbert Eiselt --- sdnr/wt/helpserver/provider/README.md | 34 ++++++++++++++++++++++++++++++++++ 1 file changed, 34 insertions(+) create mode 100644 sdnr/wt/helpserver/provider/README.md (limited to 'sdnr/wt/helpserver/provider/README.md') 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 -- cgit 1.2.3-korg