Commit 4744b8cf authored by Richard Glosner's avatar Richard Glosner
Browse files

Merge branch '105-update-known-issues' into 'main'

update known issues section

Closes #105

See merge request inject/inject-docs!189
parents 22bdd301 a4bb31be
Loading
Loading
Loading
Loading
+0 −26
Original line number Diff line number Diff line
@@ -15,40 +15,14 @@ When uploading a definition to IXP, a similar error message appears
There are 2 possible causes for this:

1. A non-text file was included in the `content` directory.
    This can commonly occur on macOS operating systems,
    where directories can contain a `.DS_STORE` metadata file.
2. The text files/names are not encoded in `utf-8`.

### Solution

For the first cause, delete these non-text files from the directory.

On macOS, you can try different tools which do not include the `.DS_STORE` file,
for example <https://www.keka.io/en/>.

For the second cause, simply change the encoding to `utf-8`.

## Log export

### Issue

Exported exercise logs contain files which were not uploaded during the exercise.

### Cause

This issue occurs when one user is assigned to multiple exercises.
If this user uploads a file during any of the exercises,
logs from all the exercises will contain the uploaded file as if it was uploaded by the team
the user is assigned to.

### Solution

When this occurs, it is quite easy to identify and fix it.
To identify files which were incorrectly added to the logs,
simply check that the files in `logs/team-X/uploaded-files/` exist in `logs/file_infos.jsonl`.
If a file does not exist in `logs/file_infos.jsonl`, it can be safely deleted from the logs
as it was not uploaded during that exercise.

## Conclusion

If you require further assistance, don't hesitate to report issues to us. The