diff --git a/docs/tech/architecture/overview.md b/docs/tech/architecture/overview.md index 6123a82216ed79ff66e02aaf0107e0e6562ad0a3..f695b8a3b808a01b4647d43b8d3a3d2a6685dbdf 100644 --- a/docs/tech/architecture/overview.md +++ b/docs/tech/architecture/overview.md @@ -214,3 +214,8 @@ def resolver(thread_id):   pass ``` --> + + +<div class="navigation" markdown> + [← Installation overview](../installation/overview.md){ .md-button } +</div> \ No newline at end of file diff --git a/docs/tech/installation/https/base-setup.md b/docs/tech/installation/https/base-setup.md index 2f5663d986aa12907eec1a4f9e0dc14760e24b2b..5966c73e84a92a572304388084d82d1bd166fcf7 100644 --- a/docs/tech/installation/https/base-setup.md +++ b/docs/tech/installation/https/base-setup.md @@ -28,3 +28,8 @@ After generating the certificates, please ensure that: - `01-substitute-env.sh` is executable via `chmod +x 01-substitute-env.sh`. Then you may execute `docker compose up -d` and your deployment is up and running + +<div class="navigation" markdown> + [← Installation overview](../overview.md){ .md-button } + [HTTPS Owncert](./owncert.md){ .md-button } +</div> \ No newline at end of file diff --git a/docs/tech/installation/https/owncert.md b/docs/tech/installation/https/owncert.md index adac42ac7eb55ec424cca1da1723bdd3812de30b..ec4e51fd47aa403b96bf240185dc63ce22683d1a 100644 --- a/docs/tech/installation/https/owncert.md +++ b/docs/tech/installation/https/owncert.md @@ -18,3 +18,8 @@ Please ensure that: - `01-substitute-env.sh` is executable via `chmod +x 01-substitute-env.sh`. Then you may execute `docker compose up -d` and your deployment is up and running + +<div class="navigation" markdown> + [← Installation overview](../overview.md){ .md-button } + [Basic HTTPS](./base-setup.md){ .md-button } +</div> \ No newline at end of file diff --git a/docs/tech/installation/overview.md b/docs/tech/installation/overview.md index 156ede67229c7873c6041bfab9c08abc6d71d000..9ca97542f0e627bc7b30e09f0292d9fad59bbfd1 100644 --- a/docs/tech/installation/overview.md +++ b/docs/tech/installation/overview.md @@ -54,4 +54,9 @@ E.g. `v2.0.0` of the frontend is fully compatible with `v2.0.0` of the backend. By following the installation guide, you'll be able to successfully set up and deploy the IXP. After completing the installation, you may download this [Intro Definition](https://gitlab.fi.muni.cz/inject/inject-docs/-/raw/main/files-from-repos/intro-definition.zip?ref_type=heads&inline=false) and try to upload it to test the platform's functionality. -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 +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. + +<div class="navigation" markdown> + [← Home](../../index.md){ .md-button } + [Troubleshooting](troubleshooting.md){ .md-button } +</div> diff --git a/docs/tech/installation/troubleshooting.md b/docs/tech/installation/troubleshooting.md index c9907d27930b8257cb576eed941cff831b09cd50..2543cb8f5e0537e3db6c99371b0228e682b4e922 100644 --- a/docs/tech/installation/troubleshooting.md +++ b/docs/tech/installation/troubleshooting.md @@ -14,4 +14,8 @@ If you encounter issues during deployment, consider the following steps: - **Frontend's error log in Developer Console is reporting mixed-origin connection issues**: Verify that connection settings in the environment varibles are setup correctely. If using HTTP deployment, that they use `http://` and `ws://` protocol, and when using HTTPS, then `https://` and `wss://`. -- **Application is connecting to an incorrect backend instance**: Clean up your cookies and session storage to enforce rebinding of the Frontend client. \ No newline at end of file +- **Application is connecting to an incorrect backend instance**: Clean up your cookies and session storage to enforce rebinding of the Frontend client. + +<div class="navigation" markdown> + [← Installation overview](./overview.md){ .md-button } +</div> \ No newline at end of file diff --git a/docs/tech/installation/users.md b/docs/tech/installation/users.md index 6ad1acd1346c2f4c2b9138bba1a8984bdd1d03f1..dd511ee1e1e7475e41eaffc0a4f73e6ed7df24c3 100644 --- a/docs/tech/installation/users.md +++ b/docs/tech/installation/users.md @@ -30,4 +30,8 @@ After launching the deployment, please wait for all migrations to finish and exe After creation of the user, you may login into the IXP. -If you need to create normal users, then please refer to the [User Onboarding](./../security.md#user-onboarding). \ No newline at end of file +If you need to create normal users, then please refer to the [User Onboarding](./../security.md#user-onboarding). + +<div class="navigation" markdown> + [← Installation overview](overview.md){ .md-button } +</div> diff --git a/docs/tech/tech_overview.md b/docs/tech/tech_overview.md deleted file mode 100644 index 1af62b7846897a06a1b82f068cbcb033b3222bd8..0000000000000000000000000000000000000000 --- a/docs/tech/tech_overview.md +++ /dev/null @@ -1,44 +0,0 @@ -# Technical documentation – Overview - -This section provides comprehensive information and resources for understanding, installing, and maintaining the INJECT Exercise Platform (IXP). -Each part of this section is designed to help developers, system administrators, and other stakeholders effectively utilize the platform. - -## Contents - -### 1. Installation Guide - -- [Installation Guide](installation/overview.md): - This guide provides detailed, step-by-step instructions for deploying the IXP using Docker Compose and Nginx. - It covers prerequisites, environment variables configuration, HTTPS deployment, creating a superuser, and troubleshooting tips. - -### 2. Authentication and Authorization - -- [Authentication and Authorization](security.md): - This section outlines the authentication and authorization mechanisms implemented in the IXP. - It includes detailed descriptions of the authentication processes, such as - how users are authenticated using Django's session system with cookies, and - authorization mechanisms, detailing the role-based access control (RBAC) and access control lists (ACL) used to manage user permissions. - By understanding and following the guidelines, you can protect your data and ensure that only authorized users have access to sensitive information. - -### 3. API Documentation - -- [API Overview](api/overview.md): - This document provides an overview of the APIs available in the IXP, explaining the purpose and usage of each API. - It sets the stage for more detailed documentation found in the subsequent files. -- [Swagger Documentation](api/swagger-docs.md): - Detailed documentation generated from the OpenAPI specification, providing a user-friendly interface to explore and test the API endpoints. - -### 4. Architecture - -- [Architecture Overview](architecture/overview.md): - This document gives a high-level overview of the architecture of the IXP, - describing the main components, their interactions, and the overall system design. - It includes diagrams and explanations to help you understand how the platform is structured and how the different parts work together. -- [Definitions](architecture/definitions/README.md): - A detailed description of the key components and concepts within the IXP. - This section serves as a glossary, helping you understand specific terms and their meanings in the context of the platform. - -## Getting Started - -To begin your journey with the IXP, we recommend starting with the [Installation Guide](installation/overview.md). -This guide will help you set up the platform using Docker Compose and Nginx, ensuring that all components are correctly configured and running smoothly. diff --git a/mkdocs.yml b/mkdocs.yml index c69113b827939403651bdfc9475d69b10c00ae88..0c94875c9dfc29252a4a277fd3ee307852426b01 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -13,7 +13,6 @@ copyright: Copyright © 2024 Masaryk University nav: - Home: index.md - Technical documentation: - - Overview: tech/tech_overview.md - Installation: - Overview: tech/installation/overview.md - Setup: tech/installation/setup.md