summaryrefslogtreecommitdiffstats
path: root/documentation
diff options
context:
space:
mode:
authorJannik Schönartz2019-05-09 14:50:18 +0200
committerJannik Schönartz2019-05-09 14:50:18 +0200
commit9bfc5a40d31b9f0c3acfb4f874dc5892b557976f (patch)
treeb57da1195d388a382f135d3beb5932e22114a069 /documentation
parent[eventmanager] fix date/time picker language (diff)
downloadbas-9bfc5a40d31b9f0c3acfb4f874dc5892b557976f.tar.gz
bas-9bfc5a40d31b9f0c3acfb4f874dc5892b557976f.tar.xz
bas-9bfc5a40d31b9f0c3acfb4f874dc5892b557976f.zip
[documentation] Add first webapp module (user management) with screenshots
Diffstat (limited to 'documentation')
-rw-r--r--documentation/.vuepress/override.styl15
-rw-r--r--documentation/.vuepress/public/img/de/bas_screenshot.PNGbin85869 -> 0 bytes
-rw-r--r--documentation/.vuepress/public/img/user_management.pngbin0 -> 138240 bytes
-rw-r--r--documentation/.vuepress/public/img/user_management_de.pngbin0 -> 141434 bytes
-rw-r--r--documentation/.vuepress/public/img/user_management_edit.pngbin0 -> 156917 bytes
-rw-r--r--documentation/.vuepress/public/img/user_management_edit_de.pngbin0 -> 166359 bytes
-rw-r--r--documentation/de/webapp/modules.md19
-rw-r--r--documentation/webapp/README.md2
-rw-r--r--documentation/webapp/modules.md22
9 files changed, 54 insertions, 4 deletions
diff --git a/documentation/.vuepress/override.styl b/documentation/.vuepress/override.styl
index 8090c85..d807f5d 100644
--- a/documentation/.vuepress/override.styl
+++ b/documentation/.vuepress/override.styl
@@ -92,3 +92,18 @@ blockquote
background-color $fgColor
color $color
border-right $border solid 1px
+
+.tutorial-label
+ font-weight: bold
+ opacity: 1
+ border-radius: 50%
+ border: 2px solid red
+ color: white
+ width: 20px
+ height: 20px
+ font-size: 13px
+ text-align: center
+ background-color: red
+ display: inline-flex
+ align-items: center
+ justify-content: center \ No newline at end of file
diff --git a/documentation/.vuepress/public/img/de/bas_screenshot.PNG b/documentation/.vuepress/public/img/de/bas_screenshot.PNG
deleted file mode 100644
index 2fb8504..0000000
--- a/documentation/.vuepress/public/img/de/bas_screenshot.PNG
+++ /dev/null
Binary files differ
diff --git a/documentation/.vuepress/public/img/user_management.png b/documentation/.vuepress/public/img/user_management.png
new file mode 100644
index 0000000..67f5321
--- /dev/null
+++ b/documentation/.vuepress/public/img/user_management.png
Binary files differ
diff --git a/documentation/.vuepress/public/img/user_management_de.png b/documentation/.vuepress/public/img/user_management_de.png
new file mode 100644
index 0000000..a0e00ba
--- /dev/null
+++ b/documentation/.vuepress/public/img/user_management_de.png
Binary files differ
diff --git a/documentation/.vuepress/public/img/user_management_edit.png b/documentation/.vuepress/public/img/user_management_edit.png
new file mode 100644
index 0000000..6475c18
--- /dev/null
+++ b/documentation/.vuepress/public/img/user_management_edit.png
Binary files differ
diff --git a/documentation/.vuepress/public/img/user_management_edit_de.png b/documentation/.vuepress/public/img/user_management_edit_de.png
new file mode 100644
index 0000000..a50babc
--- /dev/null
+++ b/documentation/.vuepress/public/img/user_management_edit_de.png
Binary files differ
diff --git a/documentation/de/webapp/modules.md b/documentation/de/webapp/modules.md
index fa01182..ab20c71 100644
--- a/documentation/de/webapp/modules.md
+++ b/documentation/de/webapp/modules.md
@@ -1,9 +1,26 @@
# Module
## Gruppen / Clients
+## IP Bereiche
## iPXE Konfigurator
## Client Registrierung
+## Eventverwaltung
## Externe Backends
## Rechtemanager
## iPXE Builder
-## Nutzermanagement \ No newline at end of file
+## Nutzermanagement
+Dieses Modul liefert eine Übersichtstabelle von allen Benutzern.
+
+<a :href="$withBase('/img/user_management_de.png')" target="_blank"><img :src="$withBase('/img/user_management_de.png')" alt="Benutzerverwaltung"></a>
+
+Wird ein Benutzer erstellt <span class="tutorial-label">1</span> oder bearbeitet <span class="tutorial-label">3</span>, so öffnet sich ein entsprechender Dialog.
+Ausgewählte Benutzer können mit dem Löschen Button <span class="tutorial-label">2</span> gelöscht werden.
+
+<a :href="$withBase('/img/user_management_edit_de.png')" target="_blank"><img :src="$withBase('/img/user_management_edit_de.png')" alt="Benutzer Editieren"></a>
+
+Permissions:
+* View - The permission to see the overview of the existing users.
+* Edit - The permission to edit users.
+* Delete - The permission to delete users.
+
+## Permission Manager
diff --git a/documentation/webapp/README.md b/documentation/webapp/README.md
index e916ebf..e558a66 100644
--- a/documentation/webapp/README.md
+++ b/documentation/webapp/README.md
@@ -1,3 +1,3 @@
# Webapplication
-<img :src="$withBase('/img/bas_screenshot.PNG')" alt="BAS Screenshot">
+<img :src="$withBase('/img/bas_screenshot.PNG')" alt="BAS Screenshot"> \ No newline at end of file
diff --git a/documentation/webapp/modules.md b/documentation/webapp/modules.md
index 89424ee..77ee29e 100644
--- a/documentation/webapp/modules.md
+++ b/documentation/webapp/modules.md
@@ -1,9 +1,27 @@
# Modules
## Group / Clients
+## IP Ranges
## iPXE Configurator
+## Event Manager
+
## Client Registration
## External Backends
-## Permission Manager
## iPXE Builder
-## User Management \ No newline at end of file
+
+## User Management
+This module provides a overview table of all the existing users.
+
+<a :href="$withBase('/img/user_management.png')" target="_blank"><img :src="$withBase('/img/user_management.png')" alt="User Management"></a>
+
+A user can be created <span class="tutorial-label">1</span> or edited <span class="tutorial-label">3</span>, which opens a dialog with all editable fields.
+Selected users can be deleted by pressing the delete button <span class="tutorial-label">2</span>.
+
+<a :href="$withBase('/img/user_management_edit.png')" target="_blank"><img :src="$withBase('/img/user_management_edit.png')" alt="User Edit"></a>
+
+Permissions:
+* View - The permission to see the overview of the existing users.
+* Edit - The permission to edit users.
+* Delete - The permission to delete users.
+
+## Permission Manager \ No newline at end of file