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

Database Diagram for Documentation #1608

Closed
bertocq opened this issue Jun 5, 2017 · 0 comments
Closed

Database Diagram for Documentation #1608

bertocq opened this issue Jun 5, 2017 · 0 comments

Comments

@bertocq
Copy link
Collaborator

bertocq commented Jun 5, 2017

I've tried rails-erd and railroady gems and I'm not 100% satisfied with neither of them.

Rails-erd

Seems better well maintained but for this particular project lacks an important feature: different colors in the relationship arrows (there's an issue on the project already)

Result: erd.pdf

Railroady

Seems less well maintained, and with a lot of options by default (and export to svg instead of pdf or image) but has the cool relationships arrows with colors

Result: models_complete.pdf

Both are pretty configurable (as you can see default options are different... one shows fields like id and created_at and the other doesn't show many tables for inherited models.

So my question is do you think it a Database Diagram could improve on-boarding for this project?. Maybe the smallest version possible (hidding as much as possible, only showing the most important models and relationships), but getting to that configuration with either of the gems could get some effort... maybe not worth?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants