Commit 36fa0a42 authored by Richard Glosner's avatar Richard Glosner
Browse files

docs: refactor "Report Issues" section, update NEWS section

* docs: refactor "Report Issues" section

* docs: add message to NEWS section about Dux release
parent 4a414ff0
Loading
Loading
Loading
Loading
+26 −21
Original line number Diff line number Diff line
@@ -11,16 +11,10 @@ hide:
# INJECT Exercise Platform Documentation

<div class="bigger-font-size" markdown>
Welcome! Whether you're responsible for technical deployment or facilitating tabletop exercises, this documentation will equip you with the tools and knowledge needed for successful implementation.
Welcome! Whether you're responsible for technical deployment or facilitating tabletop exercises,
this documentation will equip you with the tools and knowledge needed for successful implementation.
</div>

## Important: Pre-Release Documentation!

This documentation is for Dux (currently at version 3.30.3), our upcoming 4.0.X release. As a
development version, it's not fully tested and you may encounter bugs or unexpected behavior.

If you need a stable and thoroughly tested version, we recommend using version 3.0.X – Citadel.

## What is the INJECT Exercise Platform (IXP)?

- An open-source digital platform designed for conducting interactive tabletop exercises.
@@ -43,20 +37,31 @@ If you need a stable and thoroughly tested version, we recommend using version 3

!!! News

    *June 4, 2025* <br> Frontend version 3.0.3 is now available with WebSocket connection notifications
    and improved user experience when connection issues occur.\
    *September 10*, 2025 <br>
    We've just released the fourth version of the INJECT Exercise Platform (v4.0.0)– [Changelog](changelog.md#400).
    The entire documentation has been updated to reflect this new version.
    If you are using an older version of the platform, please check our
    [Version Compatibility](tech/version-compatibility.md) page.

    *June 4, 2025* <br>
    Frontend version 3.0.3 is now available with WebSocket connection notifications and improved user experience
    when connection issues occur.
    [Changelog](changelog.md#303-frontend).

    *April 28, 2025* <br> Frontend version 3.0.2 has been released, fixing email communication between
    teams and increasing the maximum number of teams per exercise to 50.\
    *April 28, 2025* <br>
    Frontend version 3.0.2 has been released, fixing email communication between
    teams and increasing the maximum number of teams per exercise to 50.
    [Changelog](changelog.md#302-frontend).

    *March 28, 2025* <br> Frontend version 3.0.1 is out, addressing table selection issues, exercise log
    *March 28, 2025* <br>
    Frontend version 3.0.1 is out, addressing table selection issues, exercise log
    downloads, and file viewer messaging. [Changelog](changelog.md#301-frontend).

    *February 16, 2025* <br> We've just released the third version of the INJECT Exercise Platform (v
    3.0.0)– [Changelog](changelog.md#300). The entire documentation has been updated to reflect this new
    version. If you are using an older version of the platform, please check our
    *February 16, 2025* <br>
    We've just released the third version of the INJECT Exercise Platform (v
    3.0.0)– [Changelog](changelog.md#300).
    The entire documentation has been updated to reflect this new version.
    If you are using an older version of the platform, please check our
    [Version Compatibility](tech/version-compatibility.md) page.

## The Big Picture
@@ -127,13 +132,13 @@ If you need a stable and thoroughly tested version, we recommend using version 3
    ______________________________________________________________________

    **[Glossary of Terms](glossary-of-terms.md)**: Definitions of key terms and concepts used in the
    IXP.\
    IXP. <br>
    **[Report Issue](report-issue.md)**: Instructions for reporting bugs, issues, or providing
    feedback on the IXP.\
    **[Known Issues](known-issues.md)**: A list of known issues and how to fix them.\
    feedback on the IXP. <br>
    **[Known Issues](known-issues.md)**: A list of known issues and how to fix them. <br>
    **[Acknowledgements](acknowledgements.md)**: Recognition of individuals or organizations that
    have contributed to the development or support of the IXP.\
    **[Authors](authors.md)**: Meet the team behind the development of IXP.
    have contributed to the development or support of the IXP. <br>
    **[Authors](authors.md)**: Meet the team behind the development of IXP. <br>

- ### Get in Touch

+30 −23
Original line number Diff line number Diff line
If you encounter any issues or bugs while using the INJECT Exercise Platform (IXP), please follow
the instructions below to report them. Before submitting a bug report, we recommend checking the
[Known Issues](known-issues.md) page to see if the issue has already been identified and if there
are any available fixes.
the instructions below to report them.
Before submitting a bug report, we recommend checking the [Known Issues](known-issues.md) page to see
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).
- In the subject line, briefly describe the nature of your inquiry (e.g., Bug Report: Application
    Crashes).
- Set the recipient email address to [our adress](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.
- Also make sure to include the backend and frontend versions, which you can find in the Exercise
    Panel.
- Once you have filled out all the necessary information, click the send button to dispatch your
    email to us.
    Include steps to reproduce the problem, screenshots (if applicable), and any other relevant details.
- Also make sure to include the backend and frontend versions, which you can find in the Exercise Panel.
- Once you have filled out all the necessary information, click the send button to dispatch your email to us.
- You should receive an automatic confirmation email that we have received the report.

Project maintainers may reach out to you to gather more information or provide updates on the status
of your inquiry. Respond to any communications from project maintainers directly through email.
Project maintainers may reach out to you to gather more information or provide
updates on the status of your inquiry.
Respond to any communications from project maintainers directly through email.

## Additional Tips

**Additional Tips**
When reporting an issue, please follow these guidelines to ensure a quick and effective resolution:

- Be as descriptive as possible when outlining the issue in your email. Clear and detailed
    descriptions help project maintainers understand and address the problem more effectively.
- Include any relevant attachments, such as log files or error messages, to assist project
    maintainers in diagnosing the issue.
- Check your email regularly for any follow-up communications from project maintainers regarding
    your inquiry.
- Sometimes, the confirmation email is marked as spam by the antispam filter of your email service.
- **Be Descriptive**: Provide a clear and detailed description of the problem.
    Include steps to reproduce the issue, what you expected to happen, and what actually occurred.
    Clear and detailed descriptions help project maintainers understand and address the problem more effectively.
- **Attach Relevant Files**: Include any helpful attachments, such as screenshots,
    log files, or detailed error messages, to assist in diagnosing the problem.
- **Utilize the Frontend Errors Section**: If you are using version 4.0.0 or later,
    a dedicated Errors section is available on the frontend.
    This feature stores all encountered errors.
    You can find it under **Your account** (top right corner) -> **Settings** -> **Errors**.
    Clicking on the error provides a detailed description.
    If available, please attach the relevant error details from this section to your report.
- **Monitor for Follow-Up**: Check your email regularly for follow-up communications from project maintainers.
- **Check Spam Folder**: If you don't receive a confirmation email, check your spam folder,
    as it may have been marked by your email service's anti-spam filter.

By following these steps, you can easily report bugs or provide feedback to project maintainers.
Your contributions help improve the overall quality and functionality of the project for all users.