[BACKEND] Include ERD in README.md #7
Conversation
|
I wonder if we can set it up so that each project gets it's ERD auto-updated on migration or something, then linked to from the readme. We already have auto-update of annotations from a rake task. Maybe we can hook in there, or do something similar. |
According to https://github.com/voormedia/rails-erd#auto-generation that's as simple as Once you did that, on |
|
Hmm. So yeah, let's set that up in boxcar then. That feels like an easy add |
|
I just realized the PR I linked only does the ERD installation for auto-update but does not link it to the README. However, is it possible to link a PDF into a markdown file? Or can a PDF just be checked into source and render in Git? |
|
|
@ludwigmuench PR updated with relative link |
|
@woolsox i would say if the boxcar PR is done and ERD generation is now fully automated, you can close this PR. |
|
or change it to just contain the info, that you can always find an up-to-date ERD linked in a rails project's README. |
|
@ludwigmuench updated what it says so we have a record of "what its doing" if people wonder why the hell |
| @@ -27,4 +38,8 @@ Consider the above folder structure. If you start the app by running `python mai | |||
| from package1 import module1 | |||
| from package1.module2 import function1 | |||
| from package2.subpackage1.module5 import function2 | |||
| <<<<<<< HEAD | |||
There was a problem hiding this comment.
| <<<<<<< HEAD |
| @@ -27,4 +38,8 @@ Consider the above folder structure. If you start the app by running `python mai | |||
| from package1 import module1 | |||
| from package1.module2 import function1 | |||
| from package2.subpackage1.module5 import function2 | |||
| <<<<<<< HEAD | |||
| ``` | |||
| @@ -27,4 +38,8 @@ Consider the above folder structure. If you start the app by running `python mai | |||
| from package1 import module1 | |||
| from package1.module2 import function1 | |||
| from package2.subpackage1.module5 import function2 | |||
| <<<<<<< HEAD | |||
| ``` | |||
| ======= | |||
There was a problem hiding this comment.
| ======= |
| ``` | ||
| >>>>>>> c95fd600b839fb556cb793de912278ab9d5ffe85 |
There was a problem hiding this comment.
| >>>>>>> c95fd600b839fb556cb793de912278ab9d5ffe85 |
| @@ -1,5 +1,16 @@ | |||
| # Backend | |||
|
|
|||
There was a problem hiding this comment.
| ## Ruby on Rails |
| @@ -1,5 +1,16 @@ | |||
| # Backend | |||
|
|
|||
| ## Entity-Relationship Diagrams [ERD] | |||
There was a problem hiding this comment.
| ## Entity-Relationship Diagrams [ERD] | |
| ### Entity-Relationship Diagrams [ERD] |
Boxcar ships with
rails-erdgem already included, but frankly we don't make a ton of use of it. I shared Everharbors' ERD with @ludwigmuench earlier today as an on boarding material and we realized that it should simply be included in all projects as a deliverable.