Commit 8dea8dc3 authored Sep 10, 2025 by Martin Juhás Committed by Richard Glosner Sep 10, 2025

docs: fix links and typos

* fix typo in report-issue.md

* fix index.md line too long

* fix link in changelog.md

* fixup security.md

* fix link in log-format.md

* fixup troubleshooting.md

parent 4adb2d4a

docs/changelog.md

+1 −1

Original line number	Original line	Diff line number	Diff line
	@@ -8,7 +8,7 @@ Most significant changes between the releases are listed below.**
	## You might find useful		## You might find useful

	- If you want to learn more about backend and frontend version compatibility, read the second		- 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:		- If you are looking for the changelog of the definitions, go here:
	[definitions changelog](tech/architecture/definitions/CHANGELOG.md)		[definitions changelog](tech/architecture/definitions/CHANGELOG.md)
	- If you are interested in the definition and platform compatibility, go here:		- If you are interested in the definition and platform compatibility, go here:

docs/report-issue.md

+1 −1

Original line number	Original line	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		## How to Report an Issue

	- Open your email client and create a new email.		- 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 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.		- 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.		Include steps to reproduce the problem, screenshots (if applicable), and any other relevant details.

docs/tech/installation/troubleshooting.md

+9 −4

Original line number	Original line	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		## 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		- **Frontend's error log in Developer Console is reporting mixed-origin
	connection issues**: Verify that connection settings in the environment		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		`http://` and `ws://` protocol, and when using HTTPS, then `https://` and
	`wss://`.		`wss://`.

docs/tech/log-format.md

+1 −2

Original line number	Original line	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.		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,		That is because these fields are direct copies of the fields described in the definition format,
	which can be found		which can be found [here](./architecture/definitions/README.md).
	[here](https://gitlab.fi.muni.cz/inject/backend/-/blob/main/definitions/README.md?ref_type=heads).

	### Timestamps		### Timestamps

docs/tech/security.md

+2 −2

Original line number	Original line	Diff line number	Diff line
	@@ -25,7 +25,7 @@ Three authorization roles (also called groups, not to be mistaken for in-game ro
	resources		resources
	- by creating an exercise or uploading an exercise definition, the instructor is automatically		- 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		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		- of the given exercise can see all teams in the exercise
	- can manipulate with the exercises (start, stop, create, or remove)		- can manipulate with the exercises (start, stop, create, or remove)
	- can add/remove trainees to/from teams of an exercise		- 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		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).		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.		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		- Suffixes can have any values, which can be lexicographically ordered (correct examples where
	`Exercise` or `Exercise-` are the prefix):		`Exercise` or `Exercise-` are the prefix):
	- Exercise-1, Exercise-2, Exercise-3 (those with 1 will be assigned to the first team, those		- Exercise-1, Exercise-2, Exercise-3 (those with 1 will be assigned to the first team, those