Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
15 changes: 15 additions & 0 deletions .github/matcher-htmlproofer.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
{
"__comment": "Docs: https://github.com/actions/toolkit/blob/main/docs/problem-matchers.md",
"problemMatcher": [
{
"owner": "htmlproofer",
"pattern": [
{
"regexp": "^ERROR\\s+-\\s+htmlproofer: (invalid url - .+ \\[.+\\]) \\[(.+)\\]$",
"file": 2,
"message": 1
}
]
}
]
}
4 changes: 4 additions & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -84,6 +84,10 @@ jobs:
path: .cache
restore-keys: |
mkdocs-material-
# https://github.com/actions/toolkit/blob/main/docs/commands.md#problem-matchers
- name: Add problem matcher for HTML proofer invalid url errors
run: |
echo "::add-matcher::.github/matcher-htmlproofer.json"
- name: Build site
run: uv run mkdocs build --strict

Expand Down
8 changes: 8 additions & 0 deletions REUSE.toml
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,14 @@ precedence = "override"
SPDX-FileCopyrightText = "Copyright (C) 2022 Opal Health Informatics Group at the Research Institute of the McGill University Health Centre <john.kildea@mcgill.ca>"
SPDX-License-Identifier = "MIT"

[[annotations]]
path = [
".github/matcher-htmlproofer.json",
]
precedence = "override"
SPDX-FileCopyrightText = "Copyright (C) 2026 Opal Health Informatics Group at the Research Institute of the McGill University Health Centre <john.kildea@mcgill.ca>"
SPDX-License-Identifier = "MIT"

[[annotations]]
path = [
".vscode/C4.code-snippets",
Expand Down
2 changes: 1 addition & 1 deletion docs/development/architecture/migration.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ More details about this pattern can be found in the resources below.
- [The Strangler Fig Migration Pattern | by Diana Darie | Medium](https://dianadarie.medium.com/the-strangler-fig-migration-pattern-2e20a7350511)
- [The Strangler pattern in practice - Michiel Rook's blog](https://www.michielrook.nl/2016/11/strangler-pattern-practice/)
- [What is the Strangler Fig Pattern and How it Helps Manage Legacy Code](https://www.freecodecamp.org/news/what-is-the-strangler-pattern-in-software-development/)
- [The Ship of Theseus to NOT rewrite a legacy system from scratch](https://web.archive.org/web/20241209060056/https://understandlegacycode.com/blog/ship-of-theseus-avoid-rewrite-legacy-system/)
- [The Ship of Theseus to NOT rewrite a legacy system from scratch](https://understandlegacycode.com/blog/ship-of-theseus-avoid-rewrite-legacy-system/)
- [https://docs.microsoft.com/en-us/azure/architecture/patterns/strangler-fig](https://docs.microsoft.com/en-us/azure/architecture/patterns/strangler-fig)

## Migration Process
Expand Down
2 changes: 1 addition & 1 deletion docs/development/best_practices/code_review.md
Original file line number Diff line number Diff line change
Expand Up @@ -172,6 +172,6 @@ The below list contains extra resources that may be of interest:

[^talk]: Presentation and slides on "Code Review Skills for Pythonistas": https://www.nnja.io/post/2018/2018-djangocon-code-review/

[^phauer]: Code Review Guidelines for Humans: https://phauer.com/2018/code-review-guidelines/
[^phauer]: Code Review Guidelines for Humans: https://web.archive.org/web/20250623040639/https://phauer.com/2018/code-review-guidelines/

[^twitter]: Rebecca's Rules for Constructive Code Reviews - Twitter: https://x.com/i_a_r_n_a/status/623922369376202758
7 changes: 2 additions & 5 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -110,18 +110,15 @@ plugins:
- privacy
# https://github.com/manuzhang/mkdocs-htmlproofer-plugin#configuring
- htmlproofer:
raise_error: True
# check all URLs before raising an error
raise_error_after_finish: True
raise_error_excludes:
# some URLs sporadically return a 504 (Gateway Timeout)
504: ["*"]
# sometimes URLs return a 429 (Too Many Requests)
429: ["*"]
skip_downloads: True
ignore_urls:
# non-public URLs
- https://docs.opalmedapps.ca/*
- https://opalmedapps.gitlab.io/*
# - https://github.com/opalmedapps/*
# PlantUML diagrams are included as data
- "data:*"
# Twitter URL sometimes returns a 404
Expand Down