From 00c5f8b3b180157df24e3c4a1473176fd37b9d68 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Roman=20Dvo=C5=99=C3=A1k?= <xdvora19@fi.muni.cz>
Date: Wed, 19 Jun 2024 19:07:38 +0200
Subject: [PATCH] * fix merge error
* add redirect from old link
* update known issues and report issue
* fix index page having incorrect links
* replace bug-s with issue-s
* fix formating
* rename report bugs page to report bug
* add known bugs page to other pages and minor fix
* add known bugs page
* add redirect from old link
* update known issues and report issue
* fix index page having incorrect links
* replace bug-s with issue-s
* fix formating
* rename report bugs page to report bug
* add known bugs page to other pages and minor fix
* add known bugs page
---
docs/index.md | 3 ++-
docs/known-issues.md | 32 ++++++++++++++++++++++++
docs/{report-bugs.md => report-issue.md} | 4 ++-
docs/tech/installation.md | 2 +-
mkdocs.yml | 6 ++++-
overrides/partials/copyright.html | 2 +-
poetry.lock | 21 +++++++++++++++-
pyproject.toml | 1 +
8 files changed, 65 insertions(+), 6 deletions(-)
create mode 100644 docs/known-issues.md
rename docs/{report-bugs.md => report-issue.md} (77%)
diff --git a/docs/index.md b/docs/index.md
index 7bbf486..7b9b437 100644
--- a/docs/index.md
+++ b/docs/index.md
@@ -37,6 +37,7 @@ Learn about the process of conducting tabletop exercises using the IXP.
Access supplementary materials and information related to IXP.
- **[Glossary of Terms](glossary-of-terms.md)**: Definitions of key terms and concepts used in the IXP.
-- **[Report Bugs](report-bugs.md)**: Instructions for reporting bugs, issues, or providing feedback on the IXP.
+- **[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.
- **[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.
diff --git a/docs/known-issues.md b/docs/known-issues.md
new file mode 100644
index 0000000..8877f85
--- /dev/null
+++ b/docs/known-issues.md
@@ -0,0 +1,32 @@
+# Known Issues and Fixes
+
+This page outlines the known issues associated with the platform and provides guidance on how to resolve or work around them.
+
+## Not Receiving Injects Upon Starting Platform
+
+### Issue
+
+Upon starting the exercise, you may not receive any injects.
+
+### Cause
+
+This issue may be caused by the frontend not properly refreshing to capture new injects.
+
+### Solution
+
+Refresh the page in your browser. This should force the frontend to correctly display the injects.
+
+## Multiple Tabs Issue
+
+### Issue
+
+If the user opens the app in multiple tabs, the behavior is not well defined. This may lead to unexpected issues or conflicts.
+
+### Solution
+
+Use the app in a single tab to avoid these issues.
+
+
+## Conclusion
+
+If you require further assistance, don't hesitate to report issues to us. The [Report issue](report-issue.md) page includes instructions on how to report bugs.
diff --git a/docs/report-bugs.md b/docs/report-issue.md
similarity index 77%
rename from docs/report-bugs.md
rename to docs/report-issue.md
index a2a2705..44df596 100644
--- a/docs/report-bugs.md
+++ b/docs/report-issue.md
@@ -1,10 +1,12 @@
-This guide will walk you through the steps of using Service Desk to submit your inquiries directly to the project.
+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.
* 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).
* 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 build number, 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.
Project maintainers may reach out to you to gather more information or provide updates on the status of your inquiry.
diff --git a/docs/tech/installation.md b/docs/tech/installation.md
index 59f4634..0de6617 100644
--- a/docs/tech/installation.md
+++ b/docs/tech/installation.md
@@ -44,4 +44,4 @@ tags: used_in_docs
By following the installation guide, you'll be able to successfully set up and run the IXP. After completing the installation, you may download this [showcase definition](https://gitlab.fi.muni.cz/inject/inject-docs/-/raw/main/files-from-repos/showcase-definition.zip?ref_type=heads&inline=false) and try to upload it to test the platform's functionality.
-If you encounter any bugs or require further assistance, don't hesitate to report them to us. The [Report bugs](../report-bugs.md) page includes instructions on how to report bugs.
\ No newline at end of file
+If you encounter any bugs, please refer to the [Known Issues and Fixes](../known-issues.md) page for troubleshooting steps and solutions. If you require further assistance, don't hesitate to report them to us. The [Report issue](../report-issue.md) page includes instructions on how to report bugs.
\ No newline at end of file
diff --git a/mkdocs.yml b/mkdocs.yml
index e1af071..5797577 100644
--- a/mkdocs.yml
+++ b/mkdocs.yml
@@ -37,7 +37,8 @@ nav:
# - FAQ: faq.md
- Glossary of Terms: glossary-of-terms.md
- Authors: authors.md
- - Report bugs: report-bugs.md
+ - Report issue: report-issue.md
+ - Known issues: known-issues.md
- Acknowledgements: acknowledgements.md
- How to cite: how-to-cite.md
# - License: license.md
@@ -64,3 +65,6 @@ plugins:
- render_swagger
- include-markdown
- search
+ - redirects:
+ redirect_maps:
+ 'report-bugs.md': 'report-issue.md'
diff --git a/overrides/partials/copyright.html b/overrides/partials/copyright.html
index b45c408..0bdee43 100644
--- a/overrides/partials/copyright.html
+++ b/overrides/partials/copyright.html
@@ -11,5 +11,5 @@
</a>
{% endif %}
<br>
- <a href="/inject-docs/report-bugs/">Report bugs</a>
+ <a href="/inject-docs/report-issue/">Report issue</a>
</div>
diff --git a/poetry.lock b/poetry.lock
index 8ade420..17b8040 100644
--- a/poetry.lock
+++ b/poetry.lock
@@ -388,6 +388,25 @@ files = [
{file = "mkdocs_material_extensions-1.3.1.tar.gz", hash = "sha256:10c9511cea88f568257f960358a467d12b970e1f7b2c0e5fb2bb48cab1928443"},
]
+[[package]]
+name = "mkdocs-redirects"
+version = "1.2.1"
+description = "A MkDocs plugin for dynamic page redirects to prevent broken links."
+optional = false
+python-versions = ">=3.6"
+files = [
+ {file = "mkdocs-redirects-1.2.1.tar.gz", hash = "sha256:9420066d70e2a6bb357adf86e67023dcdca1857f97f07c7fe450f8f1fb42f861"},
+ {file = "mkdocs_redirects-1.2.1-py3-none-any.whl", hash = "sha256:497089f9e0219e7389304cffefccdfa1cac5ff9509f2cb706f4c9b221726dffb"},
+]
+
+[package.dependencies]
+mkdocs = ">=1.1.1"
+
+[package.extras]
+dev = ["autoflake", "black", "isort", "pytest", "twine (>=1.13.0)"]
+release = ["twine (>=1.13.0)"]
+test = ["autoflake", "black", "isort", "pytest"]
+
[[package]]
name = "mkdocs-render-swagger-plugin"
version = "0.1.1"
@@ -781,4 +800,4 @@ bracex = ">=2.1.1"
[metadata]
lock-version = "2.0"
python-versions = "^3.10"
-content-hash = "f953b68737a7ab075a0569eefb5dcda2f8097b86f0eebf652e70068d60e4a774"
+content-hash = "d3c8e68b65a3a11053c95de74218ac056d40a7e5aadaeb54d27bdcde0f51d594"
diff --git a/pyproject.toml b/pyproject.toml
index 80f5392..7124c7d 100644
--- a/pyproject.toml
+++ b/pyproject.toml
@@ -15,6 +15,7 @@ mkdocs-material-extensions = "^1.3.1"
markdown = "^3.6"
mkdocs-render-swagger-plugin = "^0.1.1"
mkdocs-include-markdown-plugin = "^6.0.6"
+mkdocs-redirects = "^1.2.1"
[build-system]
--
GitLab