summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorChristian Hofmaier2020-03-29 17:47:39 +0200
committerChristian Hofmaier2020-03-29 17:47:39 +0200
commitfd406759dda9bc023e436c3f0653fb5b1b77d8e5 (patch)
treea87d7cbca9f112ec9bb9a1da621b55d10421d977
parent[webapp] show part of the path (full path on hover) in the select boxes for s... (diff)
downloadbas-fd406759dda9bc023e436c3f0653fb5b1b77d8e5.tar.gz
bas-fd406759dda9bc023e436c3f0653fb5b1b77d8e5.tar.xz
bas-fd406759dda9bc023e436c3f0653fb5b1b77d8e5.zip
[documentation/en] some lang fixes
-rw-r--r--documentation/api/README.md16
-rw-r--r--documentation/api/collections.md6
-rw-r--r--documentation/webapp/README.md10
-rw-r--r--documentation/webapp/faq.md14
-rw-r--r--documentation/webapp/modules.md42
5 files changed, 44 insertions, 44 deletions
diff --git a/documentation/api/README.md b/documentation/api/README.md
index d1e88e3..c617844 100644
--- a/documentation/api/README.md
+++ b/documentation/api/README.md
@@ -1,21 +1,21 @@
# Getting Started
-The Api can be called under the following address:
+The API can be called under the following address:
```
https://<domain_bss>/api/
```
The collections and resources are described in the [Collections](/api/collections.md) section.
## Authorization
-Some collections need authentication while other can be called without.
-To authenticate a request you have to send the json web token to the backend.\
-There are two way to do so
+Some collections need authentication while others can be called without.
+To authenticate a request you have to send the JSON web token to the backend.\
+There are two ways to do so
* **Authorization Header**\
Set the *Bearer* token in the *Authorization* header.
```
Authorization: Bearer <jsonwebtoken>
```
-> **\<jsonwebtoken\>** - Full json web token in the form header.payload.signature.
+> **\<jsonwebtoken\>** - Full JSON web token in form of header.payload.signature.
* **Cookies**\
To prevent that the Javascript code of the website has access to the full jwt the token is splitted in two seperate cookies.
@@ -25,12 +25,12 @@ To prevent that the Javascript code of the website has access to the full jwt th
To get the token use the login method from the [api/authentication](/api/collections.html#authentication).
## Return values
-The API returns data always in JSON format.
+The API always returns data in JSON format.
If the request was successfull it will return status code 200 and the requested data.
* [200 - OK](https://httpstatuses.com/200)\
-Request was successfull. Optional the response has an json object with the data included.
+Request was successfull. Optional the response has a JSON object with the data included.
-If a request is not successfull it will set a html status code and return a json object with a status and an error message included.
+If a request is not successfull it will set a HTML status code and return a JSON object with a status and an error message included.
```json
{
"error": "",
diff --git a/documentation/api/collections.md b/documentation/api/collections.md
index ebfed8c..b79dbed 100644
--- a/documentation/api/collections.md
+++ b/documentation/api/collections.md
@@ -1,5 +1,5 @@
# Collections
-Collections can be called with the api url appended with the collection and resource name.
+Collections can be called with the API URL appended with the collection and resource name.
```
https://<domain_bas>/api/<collection>/<resource>
```
@@ -14,7 +14,7 @@ https://<domain_bas>/api/authentication/
```
### Token Login
-Login method to get a json web token (jwt) for the Authorization header, to make authenticated api calls.
+Login method to get a JSON web token (jwt) for the Authorization header, to make authenticated API calls.
**Request**
```json
@@ -100,7 +100,7 @@ https://<domain_bas>/api/authentication/logout
## Setup
### Status
-Returns wheather the unauthorized user (root account) creation can be executed.
+Returns whether the unauthorized user (root account) creation can be executed.
**Request**
```
diff --git a/documentation/webapp/README.md b/documentation/webapp/README.md
index 5cc74aa..40a737a 100644
--- a/documentation/webapp/README.md
+++ b/documentation/webapp/README.md
@@ -2,7 +2,7 @@
<a :href="$withBase('/img/dark_light_theme.png')" target="_blank"><img :src="$withBase('/img/dark_light_theme.png')" alt="BAS Dark and Light Theme" class="image-border"></a>
-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.
+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.
<a :href="$withBase('/img/home.png')" target="_blank"><img :src="$withBase('/img/home.png')" alt="BAS Home"></a>
@@ -11,10 +11,10 @@ The sidepanel can be opened and closed with <span class="tutorial-label">2</span
There are diffent appearances of the sidepanel which can be configured in the [Settings](/webapp/README.md#settings).
> <span class="tutorial-label">3</span> changes the style of the webapplication between a light and a dark theme.\
> <span class="tutorial-label">4</span> opens the [Notifications](/webapp/README.md#notification) menu. The button has a notification counter, if there are unseen notifications.\
-> <span class="tutorial-label">5</span> 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.
+> <span class="tutorial-label">5</span> 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 log out of the webapplication.
## User Account
-In the user account module the user is able to change some of his informations.
+In the user account module the user is able to change some of his information.
<a :href="$withBase('/img/account.png')" target="_blank"><img :src="$withBase('/img/account.png')" alt="BAS Account"></a>
@@ -25,9 +25,9 @@ The change of the ```USERNAME``` is not possible in the account settings.
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 ```EDIT``` button <span class="tutorial-label">2</span>. The requirements for a password are ```>= 8 characters```.
+The ```PASSWORD``` can be changed by pressing the ```EDIT``` button <span class="tutorial-label">2</span>. The requirements for a password are ```>= 8 characters```.
-With the ```DELETE``` button <span class="tutorial-label">3</span> the user can delete his account.
+Using the ```DELETE``` button <span class="tutorial-label">3</span> the user can delete his account.
::: danger
Deleting your account can **NOT** be undone.
:::
diff --git a/documentation/webapp/faq.md b/documentation/webapp/faq.md
index 1cbd500..468c733 100644
--- a/documentation/webapp/faq.md
+++ b/documentation/webapp/faq.md
@@ -1,12 +1,12 @@
# [FAQ] How to ...
## Register a client
If a client netboots the BAS for the first time, it will boot the registration iPXE menu seen in the picture below.
-Besides the registration of a client you can also direct boot the local installed OS or boot bwLehrpool without the need to register the client.
+Besides the registration of a client you can also directly boot the local installed OS or boot bwLehrpool without the need to register the client.
<a :href="$withBase('/img/registration_menu.png')" target="_blank"><img :src="$withBase('/img/registration_menu.png')" alt="BAS Registration"></a>
::: tip
-If you add an [IP-Range](/webapp/modules.md#ip-ranges) to a group before the registration, the client will automaticly sorted in as a child of the corresponding group.
+If you add an [IP-Range](/webapp/modules.md#ip-ranges) to a group before the registration, the client will automatically be sorted in as a child of the corresponding group.
:::
There are three ways to register a client:
* [Automatic Registration](/webapp/faq.md#automatic-registration)
@@ -14,8 +14,8 @@ There are three ways to register a client:
* [Manual Registration](/webapp/faq.md#manual-registration)
### Automatic Registration:
-The automatic registration is the default option and will be started automaticly if the user doesn't interrupt the timeout of 25 seconds.
-The registration will run through without any input needed by the user.
+The automatic registration is the default option and will be started automatically if the user doesn't interrupt the timeout of 25 seconds.
+The registration will run through without any needed user input.
The client will get the next free IP of the subnet in the DHCP as the fixed IP address if there is any configured.
It's added to the BAS with a default name ```Client_<UUID>```.
@@ -34,7 +34,7 @@ This name will also be the prefix of the hostname in the DHCP.
<a :href="$withBase('/img/registration_semi_name.png')" target="_blank"><img :src="$withBase('/img/registration_semi_name.png')" alt="BAS Registration Name"></a>
-After those step an overview menu is provided, where the registration can be canceled or confirmed.
+After those steps an overview menu is provided, where the registration can be canceled or confirmed.
<a :href="$withBase('/img/registration_semi_overview.png')" target="_blank"><img :src="$withBase('/img/registration_semi_overview.png')" alt="BAS Registration Overview"></a>
@@ -46,8 +46,8 @@ In the manual registration the room where the client will be sorted in can be se
### Registration hooks
With the initial registration the client is added with the name, IP, MAC and UUID to the BAS and the backends.
-To make further custom registration steps registration hooks can be configured, which will be executed rigth after the initial registration.
-For more information about the registration hooks and how to create them go to [Registration Hooks](/webapp/modules.md#client-registration)
+To make further custom registration steps registration hooks can be configured, which will be executed right after the initial registration.
+For more information about the registration hooks and how to create them, see [Registration Hooks](/webapp/modules.md#client-registration).
## Move a pc-pool from one location to another
diff --git a/documentation/webapp/modules.md b/documentation/webapp/modules.md
index 883b781..9a20aa2 100644
--- a/documentation/webapp/modules.md
+++ b/documentation/webapp/modules.md
@@ -15,13 +15,13 @@ This switch also works in a group to show all subgroups and clients within this
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.
+To navigate 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.
+After navigating 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.
@@ -42,11 +42,11 @@ Home view:
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)
+* 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)
+* WAKE X CLIENTS UP - Start the selected clients via Wake On Lan (experimental feature: Does not work on all clients)
## IP Ranges
## iPXE Configurator
@@ -70,7 +70,7 @@ The event can be created right away without assigning any group, but then has to
> <span class="tutorial-label">2</span> - Enable this option, if the event has priority over other ongoing events. \
> <span class="tutorial-label">3</span> - Enable this option, if Wake-On-Lan shall be triggered for all assigned groups and clients at the start of the event. \
> <span class="tutorial-label">4</span> - Set start and end of the event. \
-> <span class="tutorial-label">5</span> - Enable to create an recurrent event.
+> <span class="tutorial-label">5</span> - Enable to create a recurrent event.
::: warning
Multiple ```important``` events on the same layer trigger dynamic menu building (see [Configloader](/api/collections.md#configloader)).
@@ -85,7 +85,7 @@ Multiple ```important``` events on the same layer trigger dynamic menu building
> <span class="tutorial-label">4</span> - Select the type of the interval. Options are ```days```, ```weeks``` and ```months```.
::: warning
-Activating the recurrent switch changes from an one-time event to an recurrent event, therefore changing the meaning of start date/time and end date/time.
+Activating the recurrent switch changes from an one-time event to a recurrent event, therefore changing the meaning of start date/time and end date/time.
The dates are now referring to the first and the last date of the event, with the event ongoing from start to end time at every day determined by the interval.
:::
@@ -98,11 +98,11 @@ While for ```2, week``` as interval the event is ongoing every 2nd week with the
### Groups and Clients
<a :href="$withBase('/img/event_manager_edit_step_2.png')" target="_blank"><img :src="$withBase('/img/event_manager_edit_step_2.png')" alt="BAS Event Manager Dialog"></a>
-Groups <span class="tutorial-label">1</span> and/or clients <span class="tutorial-label">2</span> which are affected by the event have to be selected.
+Groups <span class="tutorial-label">1</span> and/or clients <span class="tutorial-label">2</span>, which are affected by the event, have to be selected.
Selecting a group will activate the ```CONTINUE``` button.
The blacklist only shows subgroups and clients of the previously selected groups.
-The list is used for selecting groups and clients which shall be excluded of the event.
+The list is used for selecting groups and clients which shall be excluded from the event.
::: warning
If a previously selected group is inside of a blacklisted group, the previously selected group is not excluded from the event.
@@ -111,14 +111,14 @@ If a previously selected group is inside of a blacklisted group, the previously
## Client Registration
## External Backends
## iPXE Builder
-This module is all about the ```IPXE``` which gets delivered to the clients when booting over the network.
+This module is all about the ```iPXE``` which gets delivered to the clients when booting over the network.
<a :href="$withBase('/img/ipxe_builder_parameters.png')" target="_blank"><img :src="$withBase('/img/ipxe_builder_parameters.png')" alt="IPXE Builder Parameters"></a>
-The URL to the ipxe repository has to be defined <span class="tutorial-label">1</span>.
+The URL to the iPXE repository has to be defined <span class="tutorial-label">1</span>.
::: tip
-The default ipxe repository URL is <a>http://git.ipxe.org/ipxe.git</a>
+The default iPXE repository URL is <a>http://git.ipxe.org/ipxe.git</a>
:::
Instead of using the master branch, a branchname can be defined with <span class="tutorial-label">2</span>.
@@ -130,24 +130,24 @@ Custom build targets are added to the predefined list but can be removed using t
<a :href="$withBase('/img/ipxe_builder_console.png')" target="_blank"><img :src="$withBase('/img/ipxe_builder_console.png')" alt="IPXE Builder Console"></a>
The console shows the output of the building process.
-<span class="tutorial-label">1</span> cleans the repository. This includes removing the log and the cloned git files. The scripts or configs will stay.\
-<span class="tutorial-label">2</span> currently not working. (Should cancel the started building process)\
-<span class="tutorial-label">3</span> starts the buildig process.
+<span class="tutorial-label">1</span> cleans the repository, i.e. deletes the log and cloned git files but not the scripts or configs.\
+<span class="tutorial-label">2</span> currently not working (should cancel the started building process).\
+<span class="tutorial-label">3</span> starts the building process.
<a :href="$withBase('/img/ipxe_builder_editor.png')" target="_blank"><img :src="$withBase('/img/ipxe_builder_editor.png')" alt="IPXE Builder Editor"></a>
-There are multiple script/configs which can be edited. The script can be selected within the tabbar <span class="tutorial-label">1</span>.\
-The embedded script will be included in the builded ipxe using the ```EMBED=``` parameter.\
-The embedded certificate get included using the ```TRUST=``` parameter.\
-The ```general.h``` and the ```console.h``` are ipxe configurations. They will replace the files in the cloned repository.
+There are multiple scripts/configs which can be edited. The scripts can be selected within the tabbar <span class="tutorial-label">1</span>.\
+The embedded script will be included in the built iPXE using the ```EMBED=``` parameter.\
+The embedded certificate gets included using the ```TRUST=``` parameter.\
+The ```general.h``` and the ```console.h``` are iPXE configurations. They will replace the files in the cloned repository.
## User Management
-This module provides a overview table of all the existing users.
+This module provides an 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.
+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 information.
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>