Open
Description
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:
- Remove DB Viz from our Postgresql documentation process and replace it with SchemaSpy.
- Update the Example in the cat-ci docs to show how it is used.
- Remove the DBViz utility from cat-ci altogether (no longer required).
- Integrate the new schema documentation tooling into catalyst-voices, prior to working on DB schema updates there. #330
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.
Metadata
Metadata
Assignees
Type
Projects
Status
✅ Done