Skip to content
Snippets Groups Projects
Commit 82e50b7e authored by Roman Dvořák's avatar Roman Dvořák
Browse files

minor changes and preperations for release

parent c2db0876
No related branches found
No related tags found
No related merge requests found
We use GitLab Service Desk for bug reporting, it offers a simple and efficient way for users to report bugs, suggest features, or provide general feedback to project maintainers. This guide will walk you through the steps of using Service Desk to submit your inquiries directly to the project.
This guide will walk you through the steps of using Service Desk to submit your inquiries directly to the project.
* Open your email client and create a new email.
* Set the recipient email address to the [Service Desk email](mailto:git+inject-inject-issues-30987-issue-@gitlab.fi.muni.cz).
* 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.
* Once you have filled out all the necessary information, click the send button to dispatch your email to the Service Desk.
* Once you have filled out all the necessary information, click the send button to dispatch your email to us.
After sending your email, GitLab automatically converts it into an issue within the project's GitLab instance.
To track the status of your inquiry, you can visit the project's GitLab page and navigate to the issue tracker section.
Project maintainers may reach out to you through the GitLab issue to gather more information or provide updates on the status of your inquiry.
Respond to any communications from project maintainers directly through email. Your responses will be reflected within the associated issue in GitLab.
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**
......@@ -18,4 +15,4 @@ Respond to any communications from project maintainers directly through email. Y
* 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.
By following these steps, you can easily report bugs or provide feedback to project maintainers using GitLab Service Desk. Your contributions help improve the overall quality and functionality of the project for all users.
\ No newline at end of file
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.
\ No newline at end of file
......@@ -2,7 +2,7 @@
The INJECT API is designed to facilitate communication between the frontend and backend components of the INJECT Exercise Platform. It enables clients to perform various operations, including data retrieval, manipulation, and real-time updates.
### GraphQL API
The GraphQL API provides a flexible and efficient way to interact with the INJECT Exercise Platform. It allows clients to query specific data fields, reducing over-fetching. The [GraphQL documentation](graphql-docs.md) provides detailed information about the available queries, mutations, and subscriptions, along with examples and usage guidelines.
The GraphQL API provides a flexible and efficient way to interact with the INJECT Exercise Platform. It allows clients to query specific data fields, reducing over-fetching. The GraphQL documentation will provide detailed information about the available queries, mutations, and subscriptions, along with examples and usage guidelines.
### REST API
The REST API complements the GraphQL API by providing additional functionality and support for file transfers and other operations not supported by GraphQL. The [REST documentation](swagger-docs.md) covers endpoints, request methods, parameters, and response formats, offering comprehensive guidance for integrating with the INJECT Exercise Platform.
\ No newline at end of file
......@@ -8,11 +8,9 @@ For a deeper understanding of the overall architecture of the INJECT Exercise Pl
Before you begin, ensure that you have the following: a server with at least 1 core CPU and 4GB RAM, a 64-bit x86 architecture and root or sudo access to the server. This ensures that the backend server can handle data processing efficiently while serving the frontend interface smoothly.
The installation files for deployment are zipped and available on GitLab. You can download them from the following location:
```
https://gitlab.fi.muni.cz/inject/inject-docs/-/tree/main/files-from-repos?ref_type=heads
```
These files include all necessary configuration files, scripts, and the .env file needed for deployment.
The installation files for deployment are zipped and available on GitLab. You can download them from [here](https://gitlab.fi.muni.cz/inject/inject-docs/-/raw/main/files-from-repos/deployment-files.zip?ref_type=heads&inline=false)
These files include all necessary configuration files, scripts, and the `.env` file needed for deployment.
{%
include-markdown "../../files-from-repos/nginx-README.md"
......
site_name: INJECT documentation
site_name: INJECT Exercise Platform
theme:
name: material
favicon: 'img/inject-favicon-light-192.png'
......@@ -15,23 +15,22 @@ copyright: Copyright © 2024 Masaryk University
nav:
- Home: index.md
- Technical documentation:
- Installation:
- Installation: tech/installation.md
- Installation: tech/installation.md
- System architecture:
- Overview: tech/architecture/overview.md
- Definition documentation: tech/architecture/definitions.md
- Security features: tech/security.md
- API Documentation:
- Overview: tech/api/overview.md
- Graphql Documentation: tech/api/graphql-docs.md
- Swagger REST documentation: tech/api/swagger-docs.md
- Changelog on backend: tech/architecture/CHANGELOG.md
- FAQ: faq.md
# - Graphql Documentation: tech/api/graphql-docs.md
- Rest API documentation: tech/api/swagger-docs.md
- Backend changelog: tech/architecture/CHANGELOG.md
# - FAQ: faq.md
- Glossary of Terms: glosary-of-terms.md
- Authors: authors.md
- Report bugs: report-bugs.md
- Acknowledgements: acknowledgements.md
- License: license.md
# - License: license.md
markdown_extensions:
- attr_list
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment