cardano-foundation/catalyst-ci

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

Open

#315 opened on Sep 25, 2024

View on GitHubContributor guide
 (0 comments) (0 reactions) (1 assignee)Python (2 forks)auto 404
documentationgood first issue

Repository metrics

Stars
 (6 stars)
PR merge metrics
 (No merged PRs in 30d)

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).
  • #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.

Contributor guide

Research direction
Inspect the existing PostgreSQL documentation build workflow in this repository. Identify where DBViz is invoked and how SchemaSpy is intended to be integrated. Also review referenced issue #330 to see if it affects this task.
Tech stack
postgresql
Domain
documentationci cd
Issue type
Chore
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70