From 9ea258cf6f6064296ef4bdb0c17e77c3270351b5 Mon Sep 17 00:00:00 2001 From: Udo Walter Date: Mon, 22 Jul 2019 16:28:40 +0000 Subject: [documentation] add groups/clients module documentation --- .../.vuepress/public/img/groups_group.png | Bin 0 -> 411103 bytes .../.vuepress/public/img/groups_group_de.png | Bin 0 -> 427998 bytes documentation/.vuepress/public/img/groups_home.png | Bin 0 -> 351801 bytes .../.vuepress/public/img/groups_home_de.png | Bin 0 -> 361222 bytes documentation/de/webapp/modules.md | 47 ++++++++++++++++++++ documentation/webapp/modules.md | 49 ++++++++++++++++++++- 6 files changed, 95 insertions(+), 1 deletion(-) create mode 100644 documentation/.vuepress/public/img/groups_group.png create mode 100644 documentation/.vuepress/public/img/groups_group_de.png create mode 100644 documentation/.vuepress/public/img/groups_home.png create mode 100644 documentation/.vuepress/public/img/groups_home_de.png (limited to 'documentation') diff --git a/documentation/.vuepress/public/img/groups_group.png b/documentation/.vuepress/public/img/groups_group.png new file mode 100644 index 0000000..db97316 Binary files /dev/null and b/documentation/.vuepress/public/img/groups_group.png differ diff --git a/documentation/.vuepress/public/img/groups_group_de.png b/documentation/.vuepress/public/img/groups_group_de.png new file mode 100644 index 0000000..05fa6cd Binary files /dev/null and b/documentation/.vuepress/public/img/groups_group_de.png differ diff --git a/documentation/.vuepress/public/img/groups_home.png b/documentation/.vuepress/public/img/groups_home.png new file mode 100644 index 0000000..f5bb8e9 Binary files /dev/null and b/documentation/.vuepress/public/img/groups_home.png differ diff --git a/documentation/.vuepress/public/img/groups_home_de.png b/documentation/.vuepress/public/img/groups_home_de.png new file mode 100644 index 0000000..5b1a9d2 Binary files /dev/null and b/documentation/.vuepress/public/img/groups_home_de.png differ diff --git a/documentation/de/webapp/modules.md b/documentation/de/webapp/modules.md index dabb56e..fa520c7 100644 --- a/documentation/de/webapp/modules.md +++ b/documentation/de/webapp/modules.md @@ -1,6 +1,53 @@ # Module ## Gruppen / Clients + +BAS Groups and Clients + +In der Home Ansicht des "Gruppen / Clients" Moduls, erreichbar über das Home Symbol oben links 1, +werden alle Gruppen und Clients angezeigt, die keine Übergruppen haben. +Die Daten können über den Neu-Laden-Button 2 oben rechts aktualisiert werden, ohne dass die ganze Seite neugeladen werden muss. + +Durch das Aktivieren des "Alle" Schalters werden alle Gruppen und Clients statt nur die Gruppen und Clients der höchsten Ebenen angezeigt. +Dieser Schalter funktioniert auch in einer Gruppe um alle Untergruppen statt nur die direkten Kinder anzuzeigen. + +::: tip +Über einen Klick auf den Einklapp-Button 5 kann die Ansicht zwischen "Untereinander" und "In Tabs" gewechselt werden. +::: + +Durch einen Klick auf den Pfeil nach rechts oder einen Doppelklick auf die Zeile kann zu einer Gruppe oder einem Client gelangt werden. + +### Untergruppe / Client + +BAS Groups and Clients + +Bei einer Gruppe oder einem Client werden allgemeine Informationen über diese Gruppe oder diesen Client oben angezeigt. +Die Informationen können durch einen Klick auf den Bearbeiten-Button 1 bearbeitet werden. +Im Bearbeitungsmodus wird dieser Button durch einene Speichern-Button ersetzt, um die Änderungen zu bestätigen. + +Die Gruppe oder der Client kann über den Löschen-Button 2 gelöscht werden. + +### Tabellen mit Gruppen und Clients + +In der Home Ansicht und in einer Gruppe werden die Gruppen und Clients in zwei Tabllen angezeigt. +Durch einen Klick auf die Checkbox links (oder irgendwo in der Zeile) können die Gruppen/Clients ausgewählt werden. +Unter diesen Tabellen gibt es Buttons für weitere Aktionen. + +Home Ansicht: +* GRUPPE ERSTELLEN - Eine neue Gruppe erstellen +* CLIENT ERSTELLEN - Einen neuen Client erstellen +* X GRUPPEN LÖSCHEN - Die ausgewählten Gruppen dauerhaft löschen +* X CLIENTS LÖSCHEN - Die ausgewählten Clients dauerhaft löschen + +Gruppen Ansicht: +* UNTERGRUPPEN HINZUFÜGEN - Bereits existierende Gruppen zu dieser Gruppe hinzufügen +* CLIENTS HINZUFÜGEN - Bereits existierende Clients zu dieser Gruppe hinzufügen +* X UNTERGRUPPEN ENTFERNEN - Die ausgewählten Gruppen von dieser Gruppe entfernen (Löscht die Gruppen nicht dauerhaft) +* X CLIENTS ENTFERNEN - Die ausgewählten Clients von dieser Gruppe entfernen (Löscht die Clients nicht dauerhaft) + +Beide: +* X CLIENTS AUFWECKEN - Starte die ausgewählten Clients via Wake On Lan (Experimentelle Funktion: Funktioniert nicht bei allen Clients) + ## IP Bereiche ## iPXE Konfigurator ## Client Registrierung diff --git a/documentation/webapp/modules.md b/documentation/webapp/modules.md index 459e972..883b781 100644 --- a/documentation/webapp/modules.md +++ b/documentation/webapp/modules.md @@ -1,6 +1,53 @@ # Modules -## Group / Clients +## Groups / Clients + +BAS Groups and Clients + +Listed in the home view of the "Groups / Clients" module, accessible by the home icon in the top left 1, +are all groups and clients that have no parent group. +The data can be refreshed without reloading the page by clicking on the refresh button in the top right corner 2. + +Enabling the "All" switch 3 shows all groups and clients instead of top-level groups and clients only. +This switch also works in a group to show all subgroups and clients within this group instead of direct children only. + +::: tip +By clicking on the collapse button 5 the view can be switched from column to tabbed. +::: + +To naviate to a group or client click on the arrow on the right 4 or double click the row. + +### Subgroup / Client + +BAS Groups and Clients + +After naviating to a group or client general information about this group/client is displayed at the top. +The information can be edited by clicking on edit button 1. +In edit mode this button is replaced with a save button to confirm the changes. + +The group or client can be deleted by pressing the delete button 2. + +### Tables with Groups and Clients + +In the home view and in a group the groups and clients are displayed in two tables. +By clicking the checkbox on the left (or anywhere on the row) a group/client can be selected. +Below these tables are buttons for additional actions. + +Home view: +* CREATE GROUP - Create a new group +* CREATE CLIENT - Create a new client +* DELETE X GROUPS - Permanently delete the selected groups +* DELETE X CLIENTS - Permanently delete the selected clients + +Group view: +* ADD SUBGROUPS - Add already existing groups to this group +* ADD CLIENTS - Add already existing clients to this group +* REMOVE X SUBGROUPS - Remove the selected groups from this group (Does not permanently delete the groups) +* REMOVE X CLIENTS - Remove the selected clients from this group (Does not permanently delete the clients) + +Both: +* WAKE X CLIENTS UP - Start the selected clients via Wake On Lan (Experimental feature: Does not work on all clients) + ## IP Ranges ## iPXE Configurator ## Event Manager -- cgit v1.2.3-55-g7522