Skip to content

Commit

Permalink
fix(policy): schema markdown links should work (#1672)
Browse files Browse the repository at this point in the history
  • Loading branch information
jakedoublev authored Nov 4, 2024
1 parent 0a8b456 commit 4122262
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 1 deletion.
2 changes: 1 addition & 1 deletion service/policy/adr/0001-generate-policy-erd.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down
2 changes: 2 additions & 0 deletions service/policy/db/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down

0 comments on commit 4122262

Please sign in to comment.