Skip to content

fix(policy): schema markdown links should work #1672

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jakedoublev merged 2 commits into from
Nov 4, 2024
Merged

fix(policy): schema markdown links should work #1672

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d724b9b
fix(policy): schema markdown links should work
jakedoublev Oct 22, 2024
d75f18c
Merge branch 'main' into fix/pol-schema
jakedoublev Nov 4, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion service/policy/adr/0001-generate-policy-erd.md
View file
Open in desktop
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
View file
Open in desktop
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