Commit 59749b10 authored by Richard Glosner's avatar Richard Glosner
Browse files

Merge branch '84-cosmetic-fixes-and-updates' into 'dux'

Resolve "Cosmetic fixes and updates"

See merge request inject/inject-docs!130
parents 4adb2d4a 8dea8dc3
Loading
Loading
Loading
Loading
+1 −1
Original line number Diff line number Diff line
@@ -8,7 +8,7 @@ Most significant changes between the releases are listed below.**
## You might find useful

- If you want to learn more about backend and frontend version compatibility, read the second
    section in our [Installation Guide](tech/installation/overview.md#installation_1).
    section in our [Installation Guide](tech/installation/overview.md#installation).
- If you are looking for the changelog of the definitions, go here:
    [definitions changelog](tech/architecture/definitions/CHANGELOG.md)
- If you are interested in the definition and platform compatibility, go here:
+1 −1
Original line number Diff line number Diff line
@@ -6,7 +6,7 @@ if the issue has already been identified and if there are any available fixes.
## How to Report an Issue

- Open your email client and create a new email.
- Set the recipient email address to [our adress](mailto:git+inject-inject-issues-30987-issue-@gitlab.fi.muni.cz).
- Set the recipient email address to [our address](mailto:git+inject-inject-issues-30987-issue-@gitlab.fi.muni.cz).
- In the subject line, briefly describe the nature of your inquiry (e.g., Bug Report: Application Crashes).
- In the body of the email, provide detailed information about the issue you are experiencing.
    Include steps to reproduce the problem, screenshots (if applicable), and any other relevant details.
+9 −4
Original line number Diff line number Diff line
<!-- Note: This file is primarily defined to be used in the IXP documentation. However, it is also provided in the docker-deployment repository for reference. If you accessed this file from the docker-deployment repository, please be aware that the links used in this file may not work as expected. -->
<!--
Note: This file is primarily defined to be used in the IXP documentation.
However, it is also provided in the docker-deployment repository for reference.
If you accessed this file from the docker-deployment repository,
please be aware that the links used in this file may not work as expected.
-->

## Troubleshooting

@@ -24,7 +29,7 @@ If you encounter issues during deployment, consider the following steps:

- **Frontend's error log in Developer Console is reporting mixed-origin
    connection issues**: Verify that connection settings in the environment
    varibles are setup correctely. If using HTTP deployment, that they use
    variables are set up correctly. If using HTTP deployment, that they use
    `http://` and `ws://` protocol, and when using HTTPS, then `https://` and
    `wss://`.

+1 −2
Original line number Diff line number Diff line
@@ -35,8 +35,7 @@ Bellow is description of the structure and schema of logs.

Many of the fields described here do not contain a description.
That is because these fields are direct copies of the fields described in the definition format,
which can be found
[here](https://gitlab.fi.muni.cz/inject/backend/-/blob/main/definitions/README.md?ref_type=heads).
which can be found [here](./architecture/definitions/README.md).

### Timestamps

+2 −2
Original line number Diff line number Diff line
@@ -25,7 +25,7 @@ Three authorization roles (also called groups, not to be mistaken for in-game ro
    resources
- by creating an exercise or uploading an exercise definition, the instructor is automatically
    granted access to it – access to the exercise or definition can be removed by the other
    instructor assigned to the it (or by ADMIN)
    instructor assigned to it (or by ADMIN)
- of the given exercise can see all teams in the exercise
- can manipulate with the exercises (start, stop, create, or remove)
- can add/remove trainees to/from teams of an exercise
@@ -205,7 +205,7 @@ You can utilize one of the three options for semi-automatic assignment:
        need to use the prefix `EX`, which would also match with `EXERCISE_t1` and could cause
        incorrect assignment (if we used the prefix `EX_`, we would dodge the match with other tags).
        To simplify, the prefix is checked as a match for the first characters of the tags.
    - Prefix match is case sensitive.
    - Prefix match is case-sensitive.
    - Suffixes can have any values, which can be lexicographically ordered (correct examples where
        `Exercise` or `Exercise-` are the prefix):
        - Exercise-1, Exercise-2, Exercise-3 (those with 1 will be assigned to the first team, those