Updated user documentation

This commit is contained in:
2025-11-20 09:24:07 +01:00
parent 7ec4fd8281
commit 6203531ae6

View File

@@ -1,2 +1,74 @@
# User documentation
`TODO`
## Login
- Upon opening the page, enter the username and password the administrators set up for you.
- Then click the "Login" button.
- Now you're logged in. By using the buttons or the navigation bar you can navigate to the correct page for the task you need to complete.
## Inventory
To inventorize items, complete the following steps:
- If you have a camera:
- Press the "Scan barcode" button
- Locate the barcode on the asset
- Align the barcode with the camera until the camera closes and a modal opens
- If you don't have a camera:
- Read the asset ID from the asset you want to inventorize
- Input the asset ID into the "Asset ID" input field
- Click the "Enter asset ID manually" button
- A modal opened. Inspect the fields and their data.
- If the contents match, click "information is correct"
- If there is something wrong, click "update information", apply the modifications and then click "apply changes"
## Printing
When in the "Inventory" or "Assets" page, a blue icon should be visible on the bottom left.
- Click the blue icon. A modal should open. All Barcodes you added to the print batch will be visible here
- Layout the barcodes according to your preferences and/or requirements
- Click "print batch"
- A new page opens with a print modal. DO NOT print to a printer yet!
- Select "Save to pdf" as a target and hit "save"
- Open the exported pdf and print it using the printer of your choice.
## Assets
### Filter
Above the table rows, beneath the table header is the filter row, which contains input fields where you can set the contents to filter by.
Elements that contain the provided strings remain shown.
To filter by multiple properties (e.g. owner name and location) fill in the applicable fields.
### Detail view
To view asset details, click on the list entry of the asset you want to view the details of.
### Creation
To create an asset, click on the "Create Asset" button, fill in the applicable fields and click on "Create".
### Update
To update an asset, click on the "Update" button next to the asset in the table, modify the applicable fields and click on "Update".
### Deletion
To delete an asset, click on the "Delete" button next to the asset in the table, and confirm with "yes, delete".
## Locations
### Filter
Above the table rows, beneath the table header is the filter row, which contains input fields where you can set the contents to filter by.
Elements that contain the provided strings remain shown.
To filter by multiple properties (e.g. room name and room number) fill in the applicable fields.
### Creation
To create a location, click on the "Create Location" button, fill in the applicable fields and click on "Create".
### Update
To update a location, click on the "Update" button next to the location in the table, modify the applicable fields and click on "Update".
### Deletion
To delete a location, click on the "Delete" button next to the location in the table, and confirm with "yes, delete".
## Users
### Detail view
To view user details, click on the list entry of the user you want to view the details of.
### Creation
To create a user, click on the "Create User" button, fill in the applicable fields and click on "Create".
### Update
To update a user, click on the "Update" button next to the user in the table, modify the applicable fields and click on "Update".
### Deletion
To delete a user, click on the "Delete" button next to the user in the table, and confirm with "yes, delete".
## Groups
### Creation
To create a group, click on the "Create Group" button, fill in the applicable fields and click on "Create".
### Update
To update a group, click on the "Update" button next to the group in the table, modify the applicable fields and click on "Update".
### Deletion
To delete a group, click on the "Delete" button next to the group in the table, and confirm with "yes, delete".
## Settings
The presets are hidden by default. To edit the presets, click on "Presets".
Save the changes by clicking on "Apply settings and update presets"