Merge branch 'add-home-pages' into 'main'

Add home pages

Closes #9

See merge request inject/inject-docs!13

docs/index.md

-# Welcome to MkDocs
+# INJECT Exercise Platform Documentation
 
-For full documentation visit [mkdocs.org](https://www.mkdocs.org).
+Welcome to the INJECT Exercise Platform Documentation portal! Here, you'll find comprehensive resources to guide you through every aspect of the INJECT Exercise Platform, from installation to advanced usage.
 
-## Commands
+## Overview
 
-- `mkdocs new [dir-name]` - Create a new project.
-- `mkdocs serve` - Start the live-reloading docs server.
-- `mkdocs build` - Build the documentation site.
-- `mkdocs -h` - Print help message and exit.
+The INJECT Exercise Platform revolutionizes tabletop exercise management by providing a versatile and intuitive solution for organizations of all sizes. Whether you're a small team looking to improve emergency response protocols or a large corporation conducting complex training scenarios, INJECT Exercise Platform offers the flexibility and power to meet your needs.
 
-## Project layout
+## Technical Documentation
 
-    mkdocs.yml    # The configuration file.
-    docs/
-        index.md  # The documentation homepage.
-        ...       # Other markdown pages, images and other files.
+Explore the technical documentation to gain a deeper understanding of the platform's architecture, APIs, security measures, and installation procedures.
 
-<div class="result" markdown>
-  <div class="grid cards" markdown>
+- **[Installation Guide](tech/installation.md)**: Step-by-step instructions for deploying INJECT Exercise Platform using Docker Compose and Nginx.
+- **[Security](tech/security.md)**: Details on the security measures and practices implemented in the INJECT Exercise Platform.
+- **[API Documentation](tech/api/overview.md)**: Comprehensive documentation of the APIs provided by INJECT Exercise Platform, including RESTful APIs.
+- **[Architecture Overview](tech/architecture/overview.md)**: Detailed documentation on the architecture of the INJECT Exercise Platform, including component definitions and change logs.
 
-- grid cards showcase
-- grid cards showcase
-- grid cards showcase
-- grid cards showcase
-- grid cards showcase
-- grid cards showcase
-- grid cards showcase
-- grid cards showcase
-- grid cards showcase
+## INJECT Process
 
-  </div>
-</div>
+Learn about the process of conducting tabletop exercises using the INJECT Exercise Platform.
+
+- **[Inject Process]()**: A detailed guide on how to plan, execute, and evaluate tabletop exercises using INJECT Exercise Platform.
+
+## Additional Resources
+
+Access supplementary materials and information related to INJECT Exercise Platform.
+
+- **[Glossary of Terms](glosary-of-terms.md)**: Definitions of key terms and concepts used in the INJECT Exercise Platform.
+- **[Report Bugs](report-bugs.md)**: Instructions for reporting bugs, issues, or providing feedback on the INJECT Exercise Platform.
+- **[Acknowledgements](acknowledgements.md)**: Recognition of individuals or organizations that have contributed to the development or support of the INJECT Exercise Platform.
+- **[Authors](authors.md)**: Meet the team behind the development of INJECT Exercise Platform.
\ No newline at end of file

docs/tech/security.md

+# Authorization and User Management
+
+This section provides details on the authorization roles, user onboarding processes, and access control mechanisms implemented in the INJECT platform.
+
 ## Authorization
 For authorization processes, the RBAC (Role-based access control) is supplemented with a modified ACL (access control list)  
 

docs/tech/tech_overview.md

+# Technical Overview
+
+Welcome to the technical documentation for the INJECT Exercise Platform. This section provides comprehensive information and resources for understanding, installing, and maintaining the INJECT Exercise Platform. Each part of the documentation is designed to help developers, system administrators, and other stakeholders effectively utilize the platform.
+
+## Contents
+
+### 1. Installation Guide
+- **[Installation Guide](installation.md)**:
+  This guide provides detailed, step-by-step instructions for deploying the INJECT Exercise Platform using Docker Compose and Nginx. It covers prerequisites, environment variables configuration, HTTPS deployment, creating a superuser, and troubleshooting tips. Following this guide ensures a smooth and error-free installation process, helping you to get the platform up and running quickly.
+
+### 2. Authentication and Authorization
+- **[Authentication and Authorization](security.md)**:
+  This section outlines the authentication and authorization mechanisms implemented in the INJECT Exercise Platform. 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 INJECT Exercise Platform, 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 view of the architecture of the INJECT Exercise Platform, 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.md)**:
+  A detailed description of the key components and concepts within the INJECT Exercise Platform. This section serves as a glossary, helping you understand specific terms and their meanings in the context of the platform.
+- **[Changelog](architecture/CHANGELOG.md)**:
+  A log of all the changes, updates, and improvements made to the platform over time. This document is crucial for keeping track of the platform's evolution and understanding the history of updates and bug fixes.
+
+## Getting Started
+
+To begin your journey with the INJECT Exercise Platform, we recommend starting with the [Installation Guide](installation.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.
+
+### Installation Guide
+
+The installation guide covers everything from setting up prerequisites, such as ensuring your system meets the hardware requirements, to configuring environment variables and deploying the platform using Docker Compose. It also provides troubleshooting tips to resolve common issues you might encounter during the setup process.
+
+### Authentication and Authorization
+
+In the [Authentication and Authorization](security.md) section, you will find detailed information about the security architecture of the INJECT Exercise Platform. This includes 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.
+
+### API Documentation
+
+For developers looking to integrate their applications with INJECT Exercise Platform, the [API Overview](api/overview.md) is an excellent starting point. This section provides an introduction to the available APIs, followed by in-depth documentation for both GraphQL and RESTful APIs. The GraphQL documentation includes detailed descriptions of queries and mutations, while the OpenAPI and Swagger documentation provide a comprehensive look at the RESTful endpoints, complete with examples and testing capabilities.
+
+### Architecture
+
+Understanding the architecture of the INJECT Exercise Platform is crucial for both developers and system administrators. The [Architecture Overview](architecture/overview.md) provides a high-level look at the system, supported by detailed definitions of key components and a changelog that tracks the evolution of the platform. This section is essential for anyone looking to gain a deep understanding of how INJECT Exercise Platform is designed and how its components interact.
+
+## Conclusion
+
+This technical overview serves as a navigation hub for the INJECT Exercise Platform's technical documentation. Each section is designed to provide you with the information you need to effectively use, secure, and integrate the platform. For further details and specific instructions, please refer to the respective documentation linked above.
\ No newline at end of file

mkdocs.yml

@@ -15,16 +15,17 @@ copyright: Copyright © 2024 Masaryk University
 nav:
   - Home: index.md
   - Technical documentation:
+    - Technical Overview: tech/tech_overview.md
     - Installation: tech/installation.md
     - System architecture:
       - Overview: tech/architecture/overview.md
       - Definition documentation: tech/architecture/definitions.md
-    - Security features: tech/security.md
+      - Backend changelog: tech/architecture/CHANGELOG.md
+    - Authorization and User Management: tech/security.md
     - API Documentation:
       - Overview: tech/api/overview.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