Added by Alexandra Hilbay Q. 8 months ago
I'm wondering if anyone has or knows of a comprehensive guide or documentation:
Has anyone created or found a database structure guide?
Are there any community-maintained ERDs or schema documentation?
What's the best approach to understand the relationships between main entities?
Thanks in advance for any help or pointers!
Best regards,
Replies (1)
Hi Alexandra,
That’s a very valid question. From what I’ve seen so far, there doesn’t appear to be a single, consolidated database structure guide or ERD for OpenProject.
Most of the information about relationships seems to live in the code itself (ActiveRecord models and migrations), with some related context spread across the development documentation, but nothing that brings the overall schema together in one place.
For understanding the main entities, following associations starting from core models (like projects, work packages, users, types) seems to be the most practical approach at the moment, even though it’s not ideal from a documentation perspective.
I might have missed something, but if there is an existing guide or community-maintained ERD, I’d also be very interested to know about it. Otherwise, this feels like an area where contributor-facing documentation could be helpful in the future.
Best regards,
Lakshay