Add governance and licensing pages by davehorsfall · Pull Request #695 · direct-framework/direct-webapp

davehorsfall · 2026-04-17T08:52:14Z

Description

This PR adds a governance and licensing page to the website, where content is pulled directly from Github markdown files. Content should be cached for 1 hour.

Note: the licensing page on Github doesn't exist yet, and needs to be created. The new page should act as a centralised single point of truth on licensing across the project, and signpost people appropriately to more information as necessary.

Fixes # (issue)

Type of change

Documentation (non-breaking change that adds or improves the documentation)
New feature (non-breaking change which adds functionality)
Optimization (non-breaking, back-end change that speeds up the code)
Technical work (non-breaking, change which is work as part of a new feature)
Bug fix (non-breaking change which fixes an issue)
Breaking change (whatever its nature)

Key checklist

All tests pass (eg. python -m pytest)
The documentation builds and looks OK (eg. mkdocs serve)
Pre-commit hooks run successfully (eg. pre-commit run --all-files)

Further checks

Code is commented, particularly in hard-to-understand areas
Tests added or an issue has been opened to tackle that in the future. (Indicate issue here: # (issue))

Copilot

Pull request overview

This PR adds new “Governance” and “Licensing” policy pages and updates existing policy pages to live under a main/pages/policies/ template structure, wiring the new pages into the site navigation.

Changes:

Add GovernancePageView / LicensingPageView that fetch and render Markdown from GitHub.
Update Privacy/Terms templates + tests to use new main/pages/policies/* template paths and add “Policies” breadcrumb items.
Update footer links and add URL routes for the new pages; add mypy stub packages for requests/markdown.

Reviewed changes

Copilot reviewed 10 out of 10 changed files in this pull request and generated 9 comments.

Show a summary per file

File	Description
`tests/main/test_main_views.py`	Updates template-path assertions for Privacy/Terms views.
`pyproject.toml`	Adds typing stub packages for Markdown/requests to `dev` extras.
`main/views/page_views.py`	Adds GitHub Markdown-backed base view + governance/licensing views; updates Privacy/Terms template paths.
`main/urls.py`	Adds `governance/` and `licensing/` routes.
`main/templates/main/snippets/footer.html`	Fixes footer URL names and adds links to the new policy pages.
`main/templates/main/pages/policies/terms.html`	Adds “Policies” breadcrumb item.
`main/templates/main/pages/policies/privacy.html`	Adds “Policies” breadcrumb item and tweaks breadcrumb label.
`main/templates/main/pages/policies/licensing.html`	New template for licensing page rendering remote markdown.
`main/templates/main/pages/policies/governance.html`	New template for governance page rendering remote markdown.
`.pre-commit-config.yaml`	Adds typing stub packages for mypy hook.

Comments suppressed due to low confidence (2)

main/templates/main/pages/policies/privacy.html:9

In breadcrumbs, aria-current="page" should only be present on the active/current breadcrumb item. Here it's applied to the non-active "Policies" crumb, which is inconsistent with other templates and is inaccurate for assistive technologies.
main/templates/main/pages/policies/terms.html:9
In breadcrumbs, aria-current="page" should only be present on the active/current breadcrumb item. Here it's applied to the non-active "Policies" crumb, which is inconsistent with other templates and is inaccurate for assistive technologies.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2026-04-17T08:56:21Z

+class GovernancePageView(GitHubMarkdownPageView):
+    """View that renders the governance page from GitHub Markdown."""
+
+    template_name = "main/pages/policies/governance.html"
+    page_heading = "DIRECT Governance"
+    unavailable_message = "Governance document is temporarily unavailable."
+
+    github_raw_url = (
+        "https://raw.githubusercontent.com/direct-framework/.github/main/GOVERNANCE.md"
+    )
+
+
+# @method_decorator(cache_page(60 * 60), name="dispatch")  # cache 1 hour
+class LicensingPageView(GitHubMarkdownPageView):
+    """View that renders the licensing page from GitHub Markdown."""
+
+    template_name = "main/pages/policies/licensing.html"
+    page_heading = "DIRECT Licensing"
+    unavailable_message = "Licensing document is temporarily unavailable."
+
+    github_raw_url = (
+        "https://raw.githubusercontent.com/direct-framework/.github/main/LICENSING.md"
+    )


New Governance/Licensing views introduce network-fetch + markdown rendering behavior but there are no tests covering these routes (template used, status code, and the failure path when the GitHub fetch errors). Add view tests that mock the HTTP request (e.g., via requests-mock/pytest-mock) to keep the test suite deterministic.

anenadic

This is looking good to me - thank you @davehorsfall.

When trying to run locally - I noticed that dependencies markdown and requests are missing from requirements.txt so a pip freeze should be done.

anenadic · 2026-04-17T15:54:31Z

Suggestion for the content of the licence file (to be tweaked, just a starting point):

# LICENSE

The DIRECT project makes all of its content publicly available under open source licenses:

- Images, documentation, data and page content are made available under the [CC BY 4.0 license][cc-by-legal]
- Metadata is made available under the [CC0 1.0 Universal license][cc-0-legal]
- Software is made available under the [BSD 3-Clause License][bsd-3-license].

Check individual repositories under the DIRECT organisation for more details on individual sub-project licensing.

[cc-by-human]: https://creativecommons.org/licenses/by/4.0/
[cc-by-legal]: https://creativecommons.org/licenses/by/4.0/legalcode
[cc-0-human]: https://creativecommons.org/publicdomain/zero/1.0/
[cc-0-legal]: https://creativecommons.org/publicdomain/zero/1.0/legalcode
[bsd-3-license]: https://opensource.org/license/bsd-3-clause

AdrianDAlessandro

This is all really good! I like the approach and how the content is being pulled in and rendered. I have made a number of comments related to best practices and security. We should also have tests for the two new pages (at least rudimentary ones that just inherit TemplateOkMixin like the TestFrameworkOverviewPageView).

Also, the copilot review made some good comments, I have reacted to the ones I think are valuable with a thumbs up emoji. Please have a look at those (some of them are related to comments I made too).

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

…webapp into feat/governance

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

# Conflicts: # main/templates/main/snippets/footer.html

codecov · 2026-04-24T08:13:25Z

Codecov Report

❌ Patch coverage is 90.74074% with 5 lines in your changes missing coverage. Please review.

Files with missing lines	Patch %	Lines
main/views/page_views.py	90.56%	5 Missing ⚠️

📢 Thoughts on this report? Let us know!

davehorsfall · 2026-04-24T08:29:44Z

I think all pending points here are now addressed @AdrianDAlessandro (except the tests).

I've enabled the caching, and sanitised the external content with nh3. I've also fixed the broken test.

davehorsfall · 2026-04-24T08:31:17Z

I've also added @anenadic draft licensing text to LICENSING.md, so there is some initial content. We can tweak and expand on that if necessary.

AdrianDAlessandro

I've just pushed a couple basic tests for these two pages. Happy to merge

add governance and licensing pages

b02d171

Copilot AI review requested due to automatic review settings April 17, 2026 08:52

Copilot started reviewing on behalf of davehorsfall April 17, 2026 08:52 View session

Copilot AI reviewed Apr 17, 2026

View reviewed changes

Base automatically changed from 674-footer to main April 17, 2026 13:50

minor tweaks

be844dc

davehorsfall requested review from AdrianDAlessandro and anenadic April 17, 2026 14:57

anenadic approved these changes Apr 17, 2026

View reviewed changes

AdrianDAlessandro requested changes Apr 20, 2026

View reviewed changes

AdrianDAlessandro linked an issue Apr 20, 2026 that may be closed by this pull request

Add governance and licensing pages #699

Closed

davehorsfall and others added 10 commits April 21, 2026 11:50

Apply suggestion from @Copilot

f0c6822

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Merge branch 'feat/governance' of github.com:direct-framework/direct-…

63341d0

…webapp into feat/governance

consistent dom structure across policy pages

0191199

markdown already applied safe in view

30247bb

Apply suggestion from @Copilot

5e182ce

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

strip duplicated page title from markdown content

c6441af

add url pattern for policies

68c9282

Merge branch 'main' into feat/governance

296ec0b

# Conflicts: # main/templates/main/snippets/footer.html

Add markdown and requests to dependencies

c40574b

fix: broken test_navbar_contents test

4abedc3

sanitize requested md content with nh3

d93cd23

Add basic tests for Governance and Licensing pages

32dbee7

AdrianDAlessandro approved these changes Apr 24, 2026

View reviewed changes

AdrianDAlessandro merged commit b7bc48f into main Apr 24, 2026
5 checks passed

AdrianDAlessandro deleted the feat/governance branch April 24, 2026 15:44

Conversation

davehorsfall commented Apr 17, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Type of change

Key checklist

Further checks

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Copilot AI Apr 17, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

anenadic left a comment

Choose a reason for hiding this comment

Uh oh!

anenadic commented Apr 17, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

AdrianDAlessandro left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

codecov Bot commented Apr 24, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

davehorsfall commented Apr 24, 2026

Uh oh!

davehorsfall commented Apr 24, 2026

Uh oh!

AdrianDAlessandro left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

davehorsfall commented Apr 17, 2026 •

edited

Loading

anenadic commented Apr 17, 2026 •

edited

Loading

codecov Bot commented Apr 24, 2026 •

edited

Loading