Skip to content

docs: move ERD diagrams to PlantUML #4076

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

Open
steve-chavez opened this issue May 10, 2025 · 0 comments
Open

docs: move ERD diagrams to PlantUML #4076

steve-chavez opened this issue May 10, 2025 · 0 comments
Labels
docs Only related to documentation

Comments

@steve-chavez
Copy link
Member

Problem

We use PlantUML for almost all our diagrams, except for the ERD diagrams. This adds bloat to our Nix tooling. See:

## ERD
The ER diagrams were created with https://github.com/BurntSushi/erd/.
You can go download erd from https://github.com/BurntSushi/erd/releases and then do:
```bash
./erd_static-x86-64 -i ./er/film.er -o ../_static/film.png
```
The fonts used belong to the GNU FreeFont family. You can download them here: http://ftp.gnu.org/gnu/freefont/

These diagrams are on the Resource Embedding page.

Solution

Move the ERD diagrams to PlantUML. See an example here.

Notes

In the past we removed Latex in favor of PlantUML to reduce bloat (#3616).

@steve-chavez steve-chavez added the docs Only related to documentation label May 10, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Only related to documentation
Development

No branches or pull requests

1 participant