From 706b9efdd1b4bcfd12e1088b8887c1e8a37030d3 Mon Sep 17 00:00:00 2001 From: Jannik Schönartz Date: Sun, 19 May 2019 15:00:29 +0000 Subject: [documentation] Some corrections + image border dark / light theme image. --- documentation/.vuepress/override.styl | 5 ++++- documentation/.vuepress/public/img/home.png | Bin 231021 -> 245967 bytes documentation/.vuepress/public/img/home_de.png | Bin 236116 -> 252773 bytes documentation/.vuepress/public/img/user_menu.png | Bin 25143 -> 0 bytes documentation/de/webapp/README.md | 21 +++++++++------------ documentation/webapp/README.md | 21 +++++++++------------ 6 files changed, 22 insertions(+), 25 deletions(-) delete mode 100644 documentation/.vuepress/public/img/user_menu.png (limited to 'documentation') diff --git a/documentation/.vuepress/override.styl b/documentation/.vuepress/override.styl index d807f5d..dfebc6a 100644 --- a/documentation/.vuepress/override.styl +++ b/documentation/.vuepress/override.styl @@ -106,4 +106,7 @@ blockquote background-color: red display: inline-flex align-items: center - justify-content: center \ No newline at end of file + justify-content: center + +.image-border + border: 1px solid black diff --git a/documentation/.vuepress/public/img/home.png b/documentation/.vuepress/public/img/home.png index 812f516..53ec688 100644 Binary files a/documentation/.vuepress/public/img/home.png and b/documentation/.vuepress/public/img/home.png differ diff --git a/documentation/.vuepress/public/img/home_de.png b/documentation/.vuepress/public/img/home_de.png index a0700c3..e09db1f 100644 Binary files a/documentation/.vuepress/public/img/home_de.png and b/documentation/.vuepress/public/img/home_de.png differ diff --git a/documentation/.vuepress/public/img/user_menu.png b/documentation/.vuepress/public/img/user_menu.png deleted file mode 100644 index 3eec088..0000000 Binary files a/documentation/.vuepress/public/img/user_menu.png and /dev/null differ diff --git a/documentation/de/webapp/README.md b/documentation/de/webapp/README.md index e460e8c..bff4072 100644 --- a/documentation/de/webapp/README.md +++ b/documentation/de/webapp/README.md @@ -1,5 +1,5 @@ # Webapplikation -BAS Dark and Light Theme +BAS Dark and Light Theme Die Webapplikation ist das Frontend des BAS. Es benutzt dieselben API-Calls, die einem Benutzer zur Verfügung stehen, sodass alles, was im Frontend passiert auch über die API gemacht werden kann. @@ -9,30 +9,27 @@ Auf der linken Seite ist das Sidepanel 1, we Das Sidepanel kann mit 2 geöffnet und geschlossen werden. Das Verhalten des Sidepanels kann in den [Settings](/webapp/README.md#settings) Konfiguriert werden. -Mit 3 kann das Aussehen der Webapplikation zwischen einem hellen und einem dunklen Design gewechselt werden. -4 öffnet das [Notifications](/webapp/README.md#notification) Menü. Der Button hat zusätzlich einen Zähler für ungelesene Benachrichtigungen in der unteren rechten ecke. -Mit 5 kann ein Menü ausgeklappt werden, mit dem man zu den [Benutzereinstellungen](/webapp/README.md#user-account-settings) und [Einstellungen](/webapp/README.md#settings) navigieren oder sich Ausloggen kann. - -BAS Home - +> 3 kann das Aussehen der Webapplikation zwischen einem hellen und einem dunklen Design gewechselt werden.\ +> 4 öffnet das [Notifications](/webapp/README.md#notification) Menü. Der Button hat zusätzlich einen Zähler für ungelesene Benachrichtigungen in der unteren rechten ecke.\ +> 5 kann ein Menü ausgeklappt werden, mit dem man zu den [Benutzereinstellungen](/webapp/README.md#user-account-settings) und [Einstellungen](/webapp/README.md#settings) navigieren oder sich Ausloggen kann. ## Benutzeraccount Im Benutzeraccount Modul, kann der Benutzer einige seiner Informationen ändern. -BAS Account +BAS Account -Mit dem Bearbeitungsbutton 1 kann der Benutzer seinen ```NAMEN``` und seine ```E-MAIL``` ändern. +Mit dem ```BEARBEITEN```-Button 1 kann der Benutzer seinen ```NAMEN``` und seine ```E-MAIL``` ändern. In den Accounteinstellungen ist es nicht möglich seinen ```BENUTZERNAMEN``` zu ändern. ::: tip Der ```BENUTZERNAME``` kann nur im [Benutzermanagement](/webapp/modules.md#user-management) geändert werden. Dafür benötigt man die ```EDIT```-Rechte. ::: -Das ```PASSWORT``` kann mit 2 geändert werden. Das Passwort muss aus mindestens ```>= 8 Zeichen``` bestehen. +Das ```PASSWORT``` kann mit dem ```BEARBEITEN```-Button 2 geändert werden. Das Passwort muss aus mindestens ```>= 8 Zeichen``` bestehen. -Mit 3 kann der Benutzer seinen Account endgültig Löschen. +Mit dem ```LÖSCHEN```-Button 3 kann der Benutzer seinen Account endgültig Löschen. ::: danger -Das Löschen des Accounts 3 kann **NICHT** rückgängig gemacht werden. +Das Löschen des Accounts kann **NICHT** rückgängig gemacht werden. ::: ## Einstellungen diff --git a/documentation/webapp/README.md b/documentation/webapp/README.md index 17d06cc..5cc74aa 100644 --- a/documentation/webapp/README.md +++ b/documentation/webapp/README.md @@ -1,6 +1,6 @@ # Webapplication -BAS Dark and Light Theme +BAS Dark and Light Theme The webapplication is the frontend for the BAS. It uses the same API calls, so everything which can be done in the frontend can also be done with the API. @@ -9,30 +9,27 @@ The webapplication is the frontend for the BAS. It uses the same API calls, so e On the left side there is a sidepanel 1 with all the modules inside. The sidepanel can be opened and closed with 2. There are diffent appearances of the sidepanel which can be configured in the [Settings](/webapp/README.md#settings). -3 changes the style of the webapplication between a light and a dark theme. -4 opens the [Notifications](/webapp/README.md#notification) menu. The button has a notification counter, if there are unseen notifications. -5 opens a small menu where you can go to the [User Settings](/webapp/README.md#user-account-settings), the [Settings](/webapp/README.md#settings) or Logout of the webapplication. - -BAS Home - +> 3 changes the style of the webapplication between a light and a dark theme.\ +> 4 opens the [Notifications](/webapp/README.md#notification) menu. The button has a notification counter, if there are unseen notifications.\ +> 5 opens a small menu where you can go to the [User Settings](/webapp/README.md#user-account-settings), the [Settings](/webapp/README.md#settings) or Logout of the webapplication. ## User Account In the user account module the user is able to change some of his informations. BAS Account -With the edit Button 1 the user is able to change his ```NAME``` and his ```E-MAIL```. +With the ```EDIT``` button 1 the user is able to change his ```NAME``` and his ```E-MAIL```. The change of the ```USERNAME``` is not possible in the account settings. ::: tip -The ```USERNAME``` can only be changed in the [User Management](/webapp/modules.md#user-management) module where the ```EDIT``` permission is required. +The ```USERNAME``` can be changed in the [User Management](/webapp/modules.md#user-management) module where the ```EDIT``` permission is required. ::: -The ```PASSWORD``` can be changed with pressing the 2 button. The requirements for a password are ```>= 8 characters```. +The ```PASSWORD``` can be changed with pressing the ```EDIT``` button 2. The requirements for a password are ```>= 8 characters```. -With 3 the user can delete his account. +With the ```DELETE``` button 3 the user can delete his account. ::: danger -Deleting your account with 3 can **NOT** be undone. +Deleting your account can **NOT** be undone. ::: ## Settings -- cgit v1.2.3-55-g7522