summaryrefslogtreecommitdiffstats
path: root/documentation
diff options
context:
space:
mode:
authorUdo Walter2019-07-22 18:28:40 +0200
committerUdo Walter2019-07-22 18:28:40 +0200
commit9ea258cf6f6064296ef4bdb0c17e77c3270351b5 (patch)
tree320d04f71121e59cde0e27ed3489d94597effdf4 /documentation
parent[external-backends/idoit] Add more information in idoit (diff)
downloadbas-9ea258cf6f6064296ef4bdb0c17e77c3270351b5.tar.gz
bas-9ea258cf6f6064296ef4bdb0c17e77c3270351b5.tar.xz
bas-9ea258cf6f6064296ef4bdb0c17e77c3270351b5.zip
[documentation] add groups/clients module documentation
Diffstat (limited to 'documentation')
-rw-r--r--documentation/.vuepress/public/img/groups_group.pngbin0 -> 411103 bytes
-rw-r--r--documentation/.vuepress/public/img/groups_group_de.pngbin0 -> 427998 bytes
-rw-r--r--documentation/.vuepress/public/img/groups_home.pngbin0 -> 351801 bytes
-rw-r--r--documentation/.vuepress/public/img/groups_home_de.pngbin0 -> 361222 bytes
-rw-r--r--documentation/de/webapp/modules.md47
-rw-r--r--documentation/webapp/modules.md49
6 files changed, 95 insertions, 1 deletions
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
--- /dev/null
+++ b/documentation/.vuepress/public/img/groups_group.png
Binary files 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
--- /dev/null
+++ b/documentation/.vuepress/public/img/groups_group_de.png
Binary files 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
--- /dev/null
+++ b/documentation/.vuepress/public/img/groups_home.png
Binary files 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
--- /dev/null
+++ b/documentation/.vuepress/public/img/groups_home_de.png
Binary files 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
+
+<a :href="$withBase('/img/groups_home_de.png')" target="_blank"><img :src="$withBase('/img/groups_home_de.png')" alt="BAS Groups and Clients"></a>
+
+In der Home Ansicht des "Gruppen / Clients" Moduls, erreichbar über das Home Symbol oben links <span class="tutorial-label">1</span>,
+werden alle Gruppen und Clients angezeigt, die keine Übergruppen haben.
+Die Daten können über den Neu-Laden-Button <span class="tutorial-label">2</span> 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 <span class="tutorial-label">5</span> 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
+
+<a :href="$withBase('/img/groups_group_de.png')" target="_blank"><img :src="$withBase('/img/groups_group_de.png')" alt="BAS Groups and Clients"></a>
+
+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 <span class="tutorial-label">1</span> 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 <span class="tutorial-label">2</span> 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
+
+<a :href="$withBase('/img/groups_home.png')" target="_blank"><img :src="$withBase('/img/groups_home.png')" alt="BAS Groups and Clients"></a>
+
+Listed in the home view of the "Groups / Clients" module, accessible by the home icon in the top left <span class="tutorial-label">1</span>,
+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 <span class="tutorial-label">2</span>.
+
+Enabling the "All" switch <span class="tutorial-label">3</span> 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 <span class="tutorial-label">5</span> the view can be switched from column to tabbed.
+:::
+
+To naviate to a group or client click on the arrow on the right <span class="tutorial-label">4</span> or double click the row.
+
+### Subgroup / Client
+
+<a :href="$withBase('/img/groups_group.png')" target="_blank"><img :src="$withBase('/img/groups_group.png')" alt="BAS Groups and Clients"></a>
+
+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 <span class="tutorial-label">1</span>.
+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 <span class="tutorial-label">2</span>.
+
+### 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