diff --git a/docs/authors.md b/docs/authors.md index 40e56c215550618f8939d1a804020f15de45c7b5..361cd8b273fd26e4ad8815d22003ba8104b8e75c 100644 --- a/docs/authors.md +++ b/docs/authors.md @@ -1,7 +1,7 @@ # Project contributors | Name | Role | -|--------------------|---------------------------------------| +| ------------------ | ------------------------------------- | | VĂt Baisa | technical lead | | JindĹ™ich Burget | frontend developer | | Pavel ÄŚeleda | project manager | @@ -17,4 +17,5 @@ | Valdemar Ĺ vábenskĂ˝ | researcher | | Michal Urban | lead developer of the first prototype | | Marek VeselĂ˝ | full-stack developer | -| Jan Vykopal | principal investigator | +| Jan Vykopal | principal investigator | +| Filip Ĺ enk | frontend developer | diff --git a/docs/faq.md b/docs/faq.md index bee68d5bf9158f3e13126b70a8e593fbdf92cdab..f81c10a4fd928d78fc432d058a3fc074ac8ee9d5 100644 --- a/docs/faq.md +++ b/docs/faq.md @@ -4,6 +4,6 @@ Yes. Most navigation buttons contain a link, so you can easily open a new tab by clicking on them with the mouse wheel. However, please note that using multiple tabs may decrease the platform's performance for all users and some features, such as the read/unread states of injects, are not synchronized across tabs. Therefore, it is recommended to use this feature sparingly. -## Can I access notifications after they've disappeared? +## How can I access error notifications after they've disappeared? -Yes. By default, the last ten notifications are stored and can be accessed by clicking on the bell icon in the navigation bar. You can change this number in the settings. Furthermore, you can prevent a notification from disappearing by hovering over it with the cursor or by selecting it using the `tab` key. +Error notifications are logged and can be accessed in the user settings. Furthermore, you can prevent a notification from disappearing by hovering over it with the cursor or by selecting it using the `tab` key. diff --git a/docs/known-issues.md b/docs/known-issues.md index aaf246082977a55bc1aff45b366ffca7f05c89c3..3214a7299bcf694f8be3aefb5cf6c2aab2052cc6 100644 --- a/docs/known-issues.md +++ b/docs/known-issues.md @@ -2,53 +2,7 @@ This page outlines the known issues associated with the platform and provides guidance on how to resolve or work around them. -## Data does not update automatically - -### Issue - -Data such as injects in the individual channels, milestones reached by the selected team, or exercises in the exercise panel may not update automatically upon entering the platform. - -### Cause - -The issue is caused by WebSocket connections not being correctly established. - -### Solution - -Refresh the page in your browser. This forces a reload of all displayed data and usually leads to a properly established connection, causing data to update automatically. - -## Unauthorized REST Endpoint Request - -### Issue - -When creating a request on the REST endpoint as a non-authorized user, instead of a `Permission Denied` pop-up, an HTML error 500 is returned and this is shown: - -``` -<!doctype html> -<html lang="en"> -<head> - <title>Server Error (500)</title> -</head> -<body> - <h1>Server Error (500)</h1><p></p> -</body> -</html> -``` - -## File Upload for Email Over 100MB - -### Issue - -When uploading a file for an email that's over 100MB, an error pops up with the message `undefined - undefined`. - -### Cause - -The maximum allowed file size for uploads is currently set to 100MB. - -### Solution - -Ensure that the file size is under 100MB before attempting to upload it. - -## Exercise cannot be started after outage +## Exercise cannot be started after an outage ### Issue @@ -65,7 +19,7 @@ However, if this issue persists even after restarting the server, it could be possible that the process failed. Ensure that no lockfiles are present in the `data` directory with the name `exercise-<ID>.lock`. The `data` directory is located in the base directory of the backend. -These files can be deleted while the server is running, +These files can be deleted while the server is running, however only if there are no actual running exercises. ## Conclusion diff --git a/docs/tech/architecture/overview.md b/docs/tech/architecture/overview.md index f695b8a3b808a01b4647d43b8d3a3d2a6685dbdf..4c978d2bff9f7bf4588c68666a2eef069a8d21b7 100644 --- a/docs/tech/architecture/overview.md +++ b/docs/tech/architecture/overview.md @@ -13,8 +13,9 @@ flowchart LR A --> C(FRONTEND) C --> D(TRAINEE PANEL) C --> E(INSTRUCTOR PANEL) - C --> F(ANALYTICS PANEL) + C --> F(ANALYST PANEL) C --> J(EXERCISE PANEL) + C --> L(DEFINITION EDITOR) B --> G(EXERCISES) B --> H(EXERCISE DEFINITIONS) B --> I(RUNNING EXERCISE) diff --git a/docs/tech/installation/https/base-setup.md b/docs/tech/installation/https/base-setup.md index 5966c73e84a92a572304388084d82d1bd166fcf7..72f2a7d2e27443c512c4ee2aaa672cd6b6592665 100644 --- a/docs/tech/installation/https/base-setup.md +++ b/docs/tech/installation/https/base-setup.md @@ -14,6 +14,8 @@ Invoke the script like so, substituting the placeholders for their respective va After the certificate has been generated, an email will be sent to the provided address with additional information about the certificate. +The same script can be used to renew the certificates. + Example usage: ```bash ./cert_script.sh admin@inject.fi.muni.cz inject.fi.muni.cz @@ -27,7 +29,7 @@ After generating the certificates, please ensure that: - `INJECT_SECRET_KEY` is changed to a truly random string of characters of at least 50 characters long - `01-substitute-env.sh` is executable via `chmod +x 01-substitute-env.sh`. -Then you may execute `docker compose up -d` and your deployment is up and running +Then you may execute `docker compose up -d` and your deployment is up and running. <div class="navigation" markdown> [← Installation overview](../overview.md){ .md-button }