-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Why these changes are being introduced: EngX has been discussing ways to add more visual documentation to our applications. The Rails Mermaid ERD gem is one way to achieve that. Relevant ticket(s): N/A How this addresses that need: This adds the Rails Mermaid ERD gem and a note about updating the diagram to the PR template. However, it does not include the actual ERD markdown, because seems that it doesn't actually work just yet (see side effects). Side effects of this change: There's a Mermaid rendering issue on GitHub. Apparently, [this has been fixed upstream, but GitHub is a few versions behind](mermaid-js/mermaid#4388). I think it makes sense to add the gem for now, but I'm open to waiting until everything is working properly.
- Loading branch information
Showing
5 changed files
with
10 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -449,6 +449,7 @@ DEPENDENCIES | |
pg | ||
puma | ||
rails (~> 7.0) | ||
rails-mermaid_erd | ||
rubocop | ||
rubocop-rails | ||
rubyzip | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
# result path | ||
# default "mermaid_erd/index.html" | ||
result_path: docs/etd_erd.html |