Merge remote-tracking branch 'origin/dmp-refactoring' into accessibility-refactor

docs/docs/documentation/application/introduction.md

@@ -128,7 +128,7 @@ We welcome contributions from the community! Please check out our [contributing
 
 ## 📄 **License**
 
-OpenCDMP is released under the [MIT License](LICENSE).
+OpenCDMP is released under the [MIT License](https://github.com/OpenCDMP/OpenCDMP/blob/main/LICENSE).
 
 ---
 

docs/docs/documentation/for-devs/contributing.md

@@ -0,0 +1,39 @@
+---
+sidebar_position: 2
+description: A guide for contributing to the platform
+---
+
+# Contributing
+
+Thank you for considering contributing to OpenCDMP! This document provides guidelines to help you contribute effectively.
+
+## Table of Contents
+- [Getting Started](#getting-started)
+- [How to Contribute](#how-to-contribute)
+- [License](#license)
+
+## Getting Started
+
+To start contributing:
+1. Fork the repository.
+2. Create a new branch for your changes.
+3. Submit a pull request (PR) with a description of your changes.
+
+## How to Contribute
+
+### Reporting Bugs
+If you encounter any bugs or issues, please:
+1. Open a new [issue](https://github.com/OpenCDMP/OpenCDMP/issues).
+2. Provide a clear and descriptive title.
+3. Include steps to reproduce the issue and relevant screenshots, logs, or error messages.
+
+### Suggesting Features
+We welcome new feature ideas! Please open a [feature request](https://github.com/OpenCDMP/OpenCDMP/issues/new) and provide details on:
+- The problem you're facing.
+- The proposed solution or feature.
+- Any alternatives you have considered.
+
+## License
+
+By contributing to OpenCDMP, you agree that your contributions will be licensed under the project's [EUPL-1.2 License](https://github.com/OpenCDMP/OpenCDMP/blob/main/LICENSE).
+```

docs/docs/documentation/for-devs/integration.md

@@ -178,7 +178,7 @@ If you have any questions or need assistance with integration:
 
 - **Email**: support@opencdmp.org
 <!-- - **Community Forum**: [OpenCDMP Discussion Forum](https://forum.opencdmp.org) -->
-- **GitHub Issues**: [https://github.com/YourUsername/OpenCDMP/issues](https://github.com/YourUsername/OpenCDMP/issues)
+- **GitHub Issues**: [https://github.com/OpenCDMP/OpenCDMP/issues](https://github.com/OpenCDMP/OpenCDMP/issues)
 
 ---
 

docs/docs/documentation/getting-started/configuration/application.md

@@ -5,27 +5,114 @@ description: A guide for the platform installation process
 
 # Application
 
-# Configuring the `.env` File
+### Documentation for Backend Services Configuration
 
-The `.env` file is a crucial component for deploying **OpenCDMP** using Docker Compose. It contains environment variables that specify:
+This document provides an overview of the configuration settings for the backend services of OpenCDMP, based on their respective `app.env` files.
-
-- Versions of the container images.
-- Docker registry to be used.
-- Exposed ports for the proxy, API, and PostgreSQL services.
-
-This file is located in the same directory as the `docker-compose.yml` files.
-
-# Configuring the `.env` File
-
-The `.env` file is a crucial component for deploying **OpenCDMP** using Docker Compose. It contains environment variables that specify:
-
-- Versions of the container images.
-- Docker registry to be used.
-- Exposed ports for the proxy, API, and PostgreSQL services.
-
-This file is located in the same directory as the `docker-compose.yml` files.
 
 ---
 
-Configuring the `.env` file correctly is essential for the successful deployment of OpenCDMP. Adjust the variables according to your deployment environment and ensure consistency across all services.
+## Annotation Service Configuration
+The configuration files for is 
+### **Database Configuration**
+- **DB_CONNECTION_STRING**: `jdbc:postgresql://opendmp-postgres:5432/argos-test`
+- **DB_USER**: `argos-test-psql`
+- **DB_PASSWORD**: `N32NL48mUH6N72FsMJMGq1x34wX2`
 
+### **Server Configuration**
+- **WEB_PORT**: `8087`
+
+### **Security Configuration**
+- **IDP_ISSUER_URI**: `https://iam-devel.opendmp.eu/realms/argos-test`
+
+### **RabbitMQ Configuration**
+- **RABBIT_HOST**: `rabbitmq`
+- **RABBIT_PORT**: `5672`
+- **RABBIT_USER**: `guest`
+- **RABBIT_PASS**: `guest`
+
+---
+
+## Backend Service Configuration
+
+### **Database Configuration**
+- **DB_URL**: `jdbc:postgresql://opendmp-postgres:5432/argos-test`
+- **DB_USER**: `argos-test-psql`
+- **DB_PASS**: `N32NL48mUH6N72FsMJMGq1x34wX2`
+
+### **Elasticsearch Configuration**
+- **ELASTIC_ENABLED**: `true`
+- **ELASTIC_USE_SSL**: `true`
+- **ELASTIC_HOST**: `elasticsearch:9200`
+- **ELASTIC_USER**: `argos-api-test`
+- **ELASTIC_PASS**: `A1649362xRi22hST297jz6jg5dx1`
+- **ELASTIC_PLAN_INDEX**: `argos-dmps-test`
+- **ELASTIC_DESCRIPTION_INDEX**: `argos-descriptions-test`
+
+### **Server Configuration**
+- **WEB_PORT**: `8081`
+
+### **Storage Configuration**
+- **FILE_STORAGE**: `/storage`
+
+### **RabbitMQ Configuration**
+- **RABBIT_HOST**: `rabbitmq`
+- **RABBIT_PORT**: `5672`
+- **RABBIT_USER**: `guest`
+- **RABBIT_PASS**: `guest`
+
+### **Keycloak Configuration**
+- **KEYCLOAK_API_SERVER_URL**: `https://iam-devel.opendmp.eu/`
+- **KEYCLOAK_API_REALM**: `argos-test`
+- **KEYCLOAK_API_USERNAME**: `dmp-keycloak-api`
+- **KEYCLOAK_API_PASSWORD**: `qh354i8vSx3pVvu3U7N4Ri2B6k`
+- **KEYCLOAK_API_CLIENT_ID**: `dmp_web`
+- **KEYCLOAK_API_CLIENT_SECRET**: `INe1sYwWKZ6PuuFHT1tipXSokLaX95b1`
+
+### **Security Configuration**
+- **IDP_ISSUER_URI**: `https://iam-devel.opendmp.eu/realms/argos-test`
+- **IDP_APIKEY_CLIENT_ID**: `dmp_web`
+- **IDP_APIKEY_CLIENT_SECRET**: `INe1sYwWKZ6PuuFHT1tipXSokLaX95b1`
+- **IDP_APIKEY_SCOPE**: `dmp_plugins`
+
+---
+
+## Notification Service Configuration
+
+### **Database Configuration**
+- **DB_CONNECTION_STRING**: `jdbc:postgresql://opendmp-postgres:5432/argos-test`
+- **DB_USER**: `argos-test-psql`
+- **DB_PASSWORD**: `N32NL48mUH6N72FsMJMGq1x34wX2`
+
+### **Server Configuration**
+- **WEB_PORT**: `8080`
+
+### **Security Configuration**
+- **IDP_ISSUER_URI**: `https://iam-devel.opendmp.eu/realms/argos-test`
+
+### **RabbitMQ Configuration**
+- **RABBIT_HOST**: `rabbitmq`
+- **RABBIT_PORT**: `5672`
+- **RABBIT_USER**: `guest`
+- **RABBIT_PASS**: `guest`
+
+### **Email Configuration**
+- **MAIL_HOST**: `smtp.office365.com`
+- **MAIL_PORT**: `587`
+- **MAIL_USERNAME**: `no-reply@openaire.eu`
+- **MAIL_PASSWORD**: `@rg2024a1r3*#!`
+- **MAIL_AUTH**: `true`
+- **MAIL_TLS**: `true`
+- **MAIL_ADDRESS**: `no-reply@openaire.eu`
+
+### **Notification Service Configuration**
+- **CACHE_DISAMBIGUATION**: `ntf`
+
+---
+
+## Other Services
+
+The configuration for the remaining services (e.g., **Zenodo**, **File Transformer**) follows a similar structure, including database connections, RabbitMQ settings, and security configurations. Refer to the individual service's `app.env` file for specific details.
+
+---
+
+For more detailed documentation on configuration options for each backend service, including file transformer and Zenodo services, refer to the individual configuration files located in each service's folder.

docs/docs/documentation/getting-started/introduction.md

@@ -47,8 +47,8 @@ description: A brief introduction to the platform features
 
 ## 🛠️ **Getting Started**
 
-1. **Deploy OpenCDMP**: Follow the [Deployment Guide](https://github.com/YourUsername/OpenCDMP/blob/main/INSTALLATION.md) to set up the platform.
+1. **Deploy OpenCDMP**: Follow the [Deployment Guide](https://github.com/OpenCDMP/OpenCDMP/blob/main/INSTALLATION.md) to set up the platform.
-2. **Configure OpenCDMP**: Set up authentication and authorization by following the [Keycloak Setup Instructions](https://github.com/YourUsername/OpenCDMP/blob/main/KEYCLOAK_SETUP.md).
+2. **Configure OpenCDMP**: Set up authentication and authorization by following the [Keycloak Setup Instructions](https://github.com/OpenCDMP/OpenCDMP/blob/main/KEYCLOAK_SETUP.md).
 3. **Create your plans**: Create your Plans by leveraging the features of the platform.
 
 ---
@@ -73,25 +73,25 @@ description: A brief introduction to the platform features
 <!-- - **API Reference**: Detailed documentation of available APIs. -->
 - **Deployment Instructions**: Steps to deploy OpenCDMP in your environment.
 - **Configuration Guides**:
-  - [Environment Variables Configuration](https://github.com/YourUsername/OpenCDMP/blob/main/ENV_CONFIGURATION.md)
+  - [Environment Variables Configuration](https://github.com/OpenCDMP/OpenCDMP/blob/main/ENV_CONFIGURATION.md)
-  - [Keycloak Setup](https://github.com/YourUsername/OpenCDMP/blob/main/KEYCLOAK_SETUP.md)
+  - [Keycloak Setup](https://github.com/OpenCDMP/OpenCDMP/blob/main/KEYCLOAK_SETUP.md)
-  - [Scalability and Extensibility](https://github.com/YourUsername/OpenCDMP/blob/main/SCALABILITY_EXTENSIBILITY.md)
+  - [Scalability and Extensibility](https://github.com/OpenCDMP/OpenCDMP/blob/main/SCALABILITY_EXTENSIBILITY.md)
 
 ---
 
 ## 🤝 **Community and Support**
 
-- **GitHub Repository**: [https://github.com/YourUsername/OpenCDMP](https://github.com/YourUsername/OpenCDMP)
+- **GitHub Repository**: [https://github.com/OpenCDMP/OpenCDMP](https://github.com/OpenCDMP/OpenCDMP)
 - **Issue Tracker**: Report bugs or request features.
 - **Discussion Forum**: Join the community to discuss and share ideas.
-- **Contributing Guidelines**: Learn how to contribute to OpenCDMP. Please check out our [contributing guidelines](CONTRIBUTING.md) to get started.
+- **Contributing Guidelines**: Learn how to contribute to OpenCDMP. Please check out our [contributing guidelines](../for-devs/contributing.md) to get started.
 
 
 ---
 
 ## 📄 **License**
 
-OpenCDMP is released under the [MIT License](https://github.com/YourUsername/OpenCDMP/blob/main/LICENSE).
+OpenCDMP is released under the [EUPL-1.2 License](https://github.com/OpenCDMP/OpenCDMP/blob/main/LICENSE).
 
 ---
 
@@ -107,7 +107,7 @@ For questions or support, please contact:
 
 Start simplifying your Output Management Plans with OpenCDMP today!
 
-[Download Now](https://github.com/YourUsername/OpenCDMP/releases)
+[Download Now](https://github.com/OpenCDMP/OpenCDMP/releases)