cardano-foundation/catalyst-ci

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

オヌプン

#315 opened on 2024/09/25

 (0 件のコメント) (0 件のリアクション) (1 人の担圓者)Python (2 件のフォヌク)auto 404
documentationgood first issue

Repository metrics

Stars
 (6 個のスタヌ)
PR merge metrics
 (30d に merged PR はありたせん)

説明

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.

コントリビュヌタヌガむド