Skip to content
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.

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

Enhancement: Architecture Documentation #1494

Open
quochung-cyou opened this issue Jun 19, 2024 · 0 comments
Open

Enhancement: Architecture Documentation #1494

quochung-cyou opened this issue Jun 19, 2024 · 0 comments
Labels
enhancement New feature or request

Comments

@quochung-cyou
Copy link

Is your feature request related to a problem? Please describe.
Hi there! I'm looking for an architectural diagram or detailed documentation that explains the roles of each service within OneUptime. For instance, how ClickHouse is used for telemetry and logging data, PostgreSQL for database management, and so forth. Having this kind of documentation would really help people understand the system better, leading to more effective pull requests, testing, and overall development.

Describe the solution you'd like
It would be fantastic to have a detailed deployment diagram or a System Architecture Document (SAD) that clearly outlines the structure and function of each component within OneUptime.

Describe alternatives you've considered
I tried to get a grasp of the system's structure by going through the code, but it would be much easier and more efficient to have a straightforward, high-level overview.

Thank you for considering this request and for all the hard work that goes into making OneUptime great. I believe that having this documentation will be a valuable resource for the community. Thanks again!

@quochung-cyou quochung-cyou added the enhancement New feature or request label Jun 19, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant