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

🛠️ [TASK] : Integrate SchemaSpy into our Postgresql Docs building #315

Open
3 of 4 tasks
stevenj opened this issue Sep 25, 2024 · 0 comments
Open
3 of 4 tasks
Assignees
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@stevenj
Copy link
Collaborator

stevenj commented Sep 25, 2024

Summary

Update Postgresql Schema rendering to a better tool

Description

SchemaSpy has much better schema rendering capabilites than we do currently.
See: https://schemaspy.org/

As we will need a very good way to render and review DB schemas, and their development, it is worthwhile improving how we visualize it.

The task here involves:

Note:

  • Catalyst-Core still uses dbviz, and there is no need to update it to use the new tooling. Its version is pinned, so removing dbviz from a later version should not be a problem.
  • No other repo currently has database schemas to document, so no requirement exists to update any other docs to this.
@stevenj stevenj added documentation Improvements or additions to documentation good first issue Good for newcomers labels Sep 25, 2024
@stevenj stevenj moved this from New to 🔖 Ready in Catalyst Sep 25, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers
Projects
Status: ✅ Done
Development

No branches or pull requests

2 participants