From 412226296d579f1d9cb52f149a5e4b629a7f7908 Mon Sep 17 00:00:00 2001 From: Jake Van Vorhis <83739412+jakedoublev@users.noreply.github.com> Date: Mon, 4 Nov 2024 10:09:50 -0800 Subject: [PATCH] fix(policy): schema markdown links should work (#1672) --- service/policy/adr/0001-generate-policy-erd.md | 2 +- service/policy/db/README.md | 2 ++ 2 files changed, 3 insertions(+), 1 deletion(-) diff --git a/service/policy/adr/0001-generate-policy-erd.md b/service/policy/adr/0001-generate-policy-erd.md index 17c094681..37a917ac8 100644 --- a/service/policy/adr/0001-generate-policy-erd.md +++ b/service/policy/adr/0001-generate-policy-erd.md @@ -10,7 +10,7 @@ Automation is expected to improve maintenance of an ERD containing the entire sc We will generate a mermaid diagram `.md` schema with a Go tool called [mermerd](https://github.com/KarnerTh/mermerd) that is MIT licensed and actively maintained. -We will place it in `service/policy/db` alongside all DB code and link to it within documentation (see [generated mermerd ERD](../db/policy_erd.md)). +We will place it in `service/policy/db` alongside all DB code and link to it within documentation (see [generated mermerd ERD](../db/schema_erd.md)). At a future time, we may desire to make the following enhancements: diff --git a/service/policy/db/README.md b/service/policy/db/README.md index fa0f70d16..ea2cbc578 100644 --- a/service/policy/db/README.md +++ b/service/policy/db/README.md @@ -36,6 +36,8 @@ Other useful subcommands also exist on `sqlc`, like `vet`, `compile`, `verify`, ### Schema ERD +[Current schema](./schema_erd.md) + The schema in the policy database is managed through `Goose` migrations (see above), which are also read into the `sqlc` generated code to execute db queries within Go.