Skip to content

📝Docs about troubleshoot and system requirement #1066

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 3 commits into from
Jun 17, 2025
Merged

📝Docs about troubleshoot and system requirement #1066

merged 3 commits into from
Jun 17, 2025

Conversation

AntoLC
Copy link
Collaborator

@AntoLC AntoLC commented Jun 11, 2025

Purpose

This pull request introduces extensive documentation updates, including a new system requirements guide and troubleshooting tips for common issues. These changes aim to improve clarity on hardware, software, and configuration needs, as well as provide solutions for platform-specific problems.

System Requirements Documentation (docs/system-requirements.md):

  • Added a comprehensive guide detailing the hardware and software requirements for running the application in both development and production environments. This includes memory, CPU, storage, and network recommendations.
  • Included specific requirements for additional tools like Kubernetes, Docker, and development dependencies such as Node.js and Python.
  • Provided performance optimization tips, including Docker configuration, memory allocation, and system tuning for efficient operation.
  • Outlined scaling recommendations and monitoring strategies for production deployments.

Troubleshooting Guide (docs/troubleshoot.md):

  • Added solutions for line-ending issues on Windows, including configuring Git to preserve LF line endings and fixing repositories with incorrect line endings.
  • Documented a workaround for Minio permission issues on Windows, focusing on resolving Docker user mapping conflicts in development environments.

@AntoLC AntoLC self-assigned this Jun 11, 2025
@AntoLC AntoLC added the documentation Improvements or additions to documentation label Jun 11, 2025
@AntoLC AntoLC force-pushed the docs/troubleshoot branch from 991b483 to ed0c3f2 Compare June 11, 2025 09:15
@AntoLC AntoLC marked this pull request as ready for review June 11, 2025 09:15
@AntoLC AntoLC requested review from lunika and virgile-dev June 11, 2025 09:15
virgile-dev
virgile-dev approved these changes Jun 11, 2025
View reviewed changes
Copy link
Collaborator

@virgile-dev virgile-dev left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is awesome thanks for writing this!

lunika
lunika reviewed Jun 11, 2025
View reviewed changes
Copy link
Member

@lunika lunika left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The system requirements is describing only the development environment as I understand. And I don't know where you found the metrics (minimum and recommended) but it seems very huge values.

@AntoLC AntoLC force-pushed the docs/troubleshoot branch 3 times, most recently from 4e3e939 to d98addd Compare June 13, 2025 10:34
@AntoLC
Copy link
Collaborator Author

AntoLC commented Jun 13, 2025

I changed the system-requirements.md, more concise, with more realistic numbers and sources.
I added a section with the development stack, and one oriented production.

Feel free to improve.

@AntoLC AntoLC requested a review from lunika June 13, 2025 10:36
@AntoLC AntoLC force-pushed the docs/troubleshoot branch 2 times, most recently from e2b7c74 to f71055b Compare June 13, 2025 13:20
lunika
lunika approved these changes Jun 16, 2025
View reviewed changes
docs/troubleshoot.md Outdated

If you encounter Minio permission issues on Windows, you can temporarily disable user mapping for the Minio service:

1. **Open the `docker-compose.yml` file**
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
1. **Open the `docker-compose.yml` file**
1. **Open the `compose.yml` file**

@AntoLC AntoLC force-pushed the docs/troubleshoot branch 4 times, most recently from f95ce59 to caa63a1 Compare June 17, 2025 12:01
AntoLC added 3 commits June 17, 2025 14:06
@AntoLC
📝(project) add troubleshoot doc
9e8a7b3 
Add a troubleshooting document to help users
resolve common issues.
@AntoLC
📝(project) add system-requirement doc
3ad6d0e 
Add a new document detailing the system
requirements for the project.
@AntoLC
👥(github) update pull request template
e504f43 
We added a new section to the pull request
template to ensure that contributors
follow the correct process for submitting
pull requests.
@AntoLC AntoLC force-pushed the docs/troubleshoot branch from caa63a1 to e504f43 Compare June 17, 2025 12:07
@AntoLC AntoLC merged commit e504f43 into main Jun 17, 2025
20 of 21 checks passed
@AntoLC AntoLC deleted the docs/troubleshoot branch June 17, 2025 12:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@lunika lunika lunika approved these changes

@virgile-dev virgile-dev virgile-dev approved these changes

Assignees

@AntoLC AntoLC

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@AntoLC @lunika @virgile-dev