From dc68a5f080f939b57834360504174385dd8be0b9 Mon Sep 17 00:00:00 2001 From: Jannik Schönartz Date: Wed, 15 Apr 2020 18:02:26 +0000 Subject: [documentation] Add documentation for external backends. --- documentation/.vuepress/override.styl | 15 +++++ .../.vuepress/public/img/external_backends.png | Bin 0 -> 244438 bytes .../public/img/external_backends_add_1.png | Bin 0 -> 278125 bytes .../public/img/external_backends_add_1_de.png | Bin 0 -> 283329 bytes .../public/img/external_backends_add_2.png | Bin 0 -> 291230 bytes .../public/img/external_backends_add_2_de.png | Bin 0 -> 296811 bytes .../.vuepress/public/img/external_backends_de.png | Bin 0 -> 249763 bytes .../public/img/external_backends_sync.png | Bin 0 -> 289024 bytes .../public/img/external_backends_sync_de.png | Bin 0 -> 295654 bytes documentation/api/collections.md | 65 ++++++++++++++++----- documentation/de/webapp/README.md | 10 ++-- documentation/de/webapp/modules.md | 40 +++++++++++++ documentation/webapp/README.md | 2 +- documentation/webapp/modules.md | 40 ++++++++++++- 14 files changed, 150 insertions(+), 22 deletions(-) create mode 100644 documentation/.vuepress/public/img/external_backends.png create mode 100644 documentation/.vuepress/public/img/external_backends_add_1.png create mode 100644 documentation/.vuepress/public/img/external_backends_add_1_de.png create mode 100644 documentation/.vuepress/public/img/external_backends_add_2.png create mode 100644 documentation/.vuepress/public/img/external_backends_add_2_de.png create mode 100644 documentation/.vuepress/public/img/external_backends_de.png create mode 100644 documentation/.vuepress/public/img/external_backends_sync.png create mode 100644 documentation/.vuepress/public/img/external_backends_sync_de.png (limited to 'documentation') diff --git a/documentation/.vuepress/override.styl b/documentation/.vuepress/override.styl index dfebc6a..756d011 100644 --- a/documentation/.vuepress/override.styl +++ b/documentation/.vuepress/override.styl @@ -4,6 +4,10 @@ $textColor = #2c3e50 $borderColor = #eaecef $codeBgColor = #282c34 //$codeBgColor = #4f5665 +$textColorSuccess = #42b983 +$textColorWarning = #e7c000 +$textColorError = #c00 + // Custom variables $bgColorNav = #fff @@ -110,3 +114,14 @@ blockquote .image-border border: 1px solid black + + + +.text-success + color: $textColorSuccess + +.text-warning + color: $textColorWarning + +.text-error + color: $textColorError \ No newline at end of file diff --git a/documentation/.vuepress/public/img/external_backends.png b/documentation/.vuepress/public/img/external_backends.png new file mode 100644 index 0000000..ba386df Binary files /dev/null and b/documentation/.vuepress/public/img/external_backends.png differ diff --git a/documentation/.vuepress/public/img/external_backends_add_1.png b/documentation/.vuepress/public/img/external_backends_add_1.png new file mode 100644 index 0000000..863c725 Binary files /dev/null and b/documentation/.vuepress/public/img/external_backends_add_1.png differ diff --git a/documentation/.vuepress/public/img/external_backends_add_1_de.png b/documentation/.vuepress/public/img/external_backends_add_1_de.png new file mode 100644 index 0000000..4d8e4e6 Binary files /dev/null and b/documentation/.vuepress/public/img/external_backends_add_1_de.png differ diff --git a/documentation/.vuepress/public/img/external_backends_add_2.png b/documentation/.vuepress/public/img/external_backends_add_2.png new file mode 100644 index 0000000..6ce02a7 Binary files /dev/null and b/documentation/.vuepress/public/img/external_backends_add_2.png differ diff --git a/documentation/.vuepress/public/img/external_backends_add_2_de.png b/documentation/.vuepress/public/img/external_backends_add_2_de.png new file mode 100644 index 0000000..01a91e3 Binary files /dev/null and b/documentation/.vuepress/public/img/external_backends_add_2_de.png differ diff --git a/documentation/.vuepress/public/img/external_backends_de.png b/documentation/.vuepress/public/img/external_backends_de.png new file mode 100644 index 0000000..e4fcd5f Binary files /dev/null and b/documentation/.vuepress/public/img/external_backends_de.png differ diff --git a/documentation/.vuepress/public/img/external_backends_sync.png b/documentation/.vuepress/public/img/external_backends_sync.png new file mode 100644 index 0000000..ebb1abb Binary files /dev/null and b/documentation/.vuepress/public/img/external_backends_sync.png differ diff --git a/documentation/.vuepress/public/img/external_backends_sync_de.png b/documentation/.vuepress/public/img/external_backends_sync_de.png new file mode 100644 index 0000000..1c63591 Binary files /dev/null and b/documentation/.vuepress/public/img/external_backends_sync_de.png differ diff --git a/documentation/api/collections.md b/documentation/api/collections.md index b79dbed..e36fc0e 100644 --- a/documentation/api/collections.md +++ b/documentation/api/collections.md @@ -174,36 +174,71 @@ https:///api/registration body { "client": { "name": "", - "parents": [], + "parents": [], "type": "", "uuid": "", - "purpose": "", - "network": { - "mac": "", - "ip": "" - }, + "purpose": "", + "contacts": [ + { + "last_name": , + "first_name": + } + ], "location": { - "option": "