diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index b2f89d1a..081e7fd2 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -35,6 +35,8 @@ repos: additional_dependencies: - django-stubs[compatible-mypy] - django-stubs-ext + - types-Markdown + - types-requests - django-bootstrap5 - django-registration - django-crispy-forms diff --git a/dev-requirements.txt b/dev-requirements.txt index bd67a926..080ec9bf 100644 --- a/dev-requirements.txt +++ b/dev-requirements.txt @@ -10,8 +10,12 @@ beautifulsoup4==4.14.3 # via direct_webapp (pyproject.toml) build==1.4.2 # via pip-tools +certifi==2026.4.22 + # via requests cfgv==3.5.0 # via pre-commit +charset-normalizer==3.4.7 + # via requests click==8.3.1 # via # djlint @@ -78,6 +82,8 @@ gunicorn==25.3.0 # via direct_webapp (pyproject.toml) identify==2.6.18 # via pre-commit +idna==3.13 + # via requests iniconfig==2.3.0 # via pytest jsbeautifier==1.15.4 @@ -88,6 +94,8 @@ json5==0.14.0 # via djlint librt==0.8.1 # via mypy +markdown==3.10.2 + # via direct_webapp (pyproject.toml) mypy==1.20.0 # via # direct_webapp (pyproject.toml) @@ -96,6 +104,8 @@ mypy-extensions==1.1.0 # via mypy mysqlclient==2.2.8 # via direct_webapp (pyproject.toml) +nh3==0.3.4 + # via direct_webapp (pyproject.toml) nodeenv==1.10.0 # via pre-commit packaging==26.0 @@ -146,6 +156,8 @@ pyyaml==6.0.3 # pre-commit regex==2026.3.32 # via djlint +requests==2.33.1 + # via direct_webapp (pyproject.toml) ruff==0.15.8 # via direct_webapp (pyproject.toml) six==1.17.0 @@ -162,14 +174,22 @@ tqdm==4.67.3 # via djlint types-django-import-export==4.4.0.20260325 # via direct_webapp (pyproject.toml) +types-markdown==3.10.2.20260408 + # via direct_webapp (pyproject.toml) types-pyyaml==6.0.12.20250915 # via django-stubs +types-requests==2.33.0.20260408 + # via direct_webapp (pyproject.toml) typing-extensions==4.15.0 # via # beautifulsoup4 # django-stubs # django-stubs-ext # mypy +urllib3==2.6.3 + # via + # requests + # types-requests virtualenv==21.2.0 # via pre-commit wheel==0.46.3 diff --git a/doc-requirements.txt b/doc-requirements.txt index 64a904c7..630147ab 100644 --- a/doc-requirements.txt +++ b/doc-requirements.txt @@ -10,9 +10,9 @@ babel==2.18.0 # via mkdocs-material backrefs==6.2 # via mkdocs-material -certifi==2026.2.25 +certifi==2026.4.22 # via requests -charset-normalizer==3.4.6 +charset-normalizer==3.4.7 # via requests click==8.3.1 # via @@ -61,7 +61,7 @@ griffelib==2.0.2 # via mkdocstrings-python gunicorn==25.3.0 # via direct_webapp (pyproject.toml) -idna==3.11 +idna==3.13 # via requests jinja2==3.1.6 # via @@ -71,6 +71,7 @@ jinja2==3.1.6 # properdocs markdown==3.10.2 # via + # direct_webapp (pyproject.toml) # mkdocs # mkdocs-autorefs # mkdocs-material @@ -121,6 +122,8 @@ mkdocstrings-python==2.0.3 # via direct_webapp (pyproject.toml) mysqlclient==2.2.8 # via direct_webapp (pyproject.toml) +nh3==0.3.4 + # via direct_webapp (pyproject.toml) packaging==26.0 # via # gunicorn @@ -161,7 +164,9 @@ pyyaml-env-tag==1.1 # mkdocs # properdocs requests==2.33.1 - # via mkdocs-material + # via + # direct_webapp (pyproject.toml) + # mkdocs-material six==1.17.0 # via python-dateutil sqlparse==0.5.5 diff --git a/main/templates/main/pages/policies/governance.html b/main/templates/main/pages/policies/governance.html new file mode 100644 index 00000000..2204c884 --- /dev/null +++ b/main/templates/main/pages/policies/governance.html @@ -0,0 +1,17 @@ +{% extends "main/base.page.html" %} +{% load static %} +{% block title %} + Digital Research Competencies Framework +{% endblock title %} +{% block breadcrumb_items %} +
  • Policies
    • +
  • Governance
    • +{% endblock breadcrumb_items %} +{% block content %} +
    +

    {{ page_heading }}

    +
    +
    {{ markdown_content }}
    +
    +
    +{% endblock content %} diff --git a/main/templates/main/pages/policies/licensing.html b/main/templates/main/pages/policies/licensing.html new file mode 100644 index 00000000..373dc1d8 --- /dev/null +++ b/main/templates/main/pages/policies/licensing.html @@ -0,0 +1,17 @@ +{% extends "main/base.page.html" %} +{% load static %} +{% block title %} + Digital Research Competencies Framework +{% endblock title %} +{% block breadcrumb_items %} +
  • Policies
    • +
  • Licensing
    • +{% endblock breadcrumb_items %} +{% block content %} +
    +

    {{ page_heading }}

    +
    +
    {{ markdown_content }}
    +
    +
    +{% endblock content %} diff --git a/main/templates/main/pages/privacy.html b/main/templates/main/pages/policies/privacy.html similarity index 98% rename from main/templates/main/pages/privacy.html rename to main/templates/main/pages/policies/privacy.html index 6840f5ef..1adcfdb6 100644 --- a/main/templates/main/pages/privacy.html +++ b/main/templates/main/pages/policies/privacy.html @@ -4,7 +4,8 @@ Digital Research Competencies Framework {% endblock title %} {% block breadcrumb_items %} -
  • Privacy Policy
    • +
  • Policies
    • +
  • Privacy
    • {% endblock breadcrumb_items %} {% block content %}
    diff --git a/main/templates/main/pages/terms.html b/main/templates/main/pages/policies/terms.html similarity index 97% rename from main/templates/main/pages/terms.html rename to main/templates/main/pages/policies/terms.html index 363e2c99..d52f8ed6 100644 --- a/main/templates/main/pages/terms.html +++ b/main/templates/main/pages/policies/terms.html @@ -4,13 +4,12 @@ Digital Research Competencies Framework {% endblock title %} {% block breadcrumb_items %} +
  • Policies
  • Terms and Conditions
    • {% endblock breadcrumb_items %} {% block content %} -
    +

    Terms and Conditions

    -
    -

    diff --git a/main/templates/main/snippets/footer.html b/main/templates/main/snippets/footer.html index e5530c40..d15cbb0a 100644 --- a/main/templates/main/snippets/footer.html +++ b/main/templates/main/snippets/footer.html @@ -89,6 +89,9 @@

    About
    Framework
      +
    • + Overview +
    • Competencies framework
      • @@ -107,10 +110,10 @@
      Framework
      Policies
      diff --git a/main/urls.py b/main/urls.py index 352256dc..9cadf697 100644 --- a/main/urls.py +++ b/main/urls.py @@ -33,9 +33,15 @@ path("overview/", views.AccountOverviewView.as_view(), name="account-overview"), ] +policies_patterns = [ + path("privacy/", views.PrivacyPageView.as_view(), name="privacy"), + path("terms/", views.TermsPageView.as_view(), name="terms"), + path("governance/", views.GovernancePageView.as_view(), name="governance"), + path("licensing/", views.LicensingPageView.as_view(), name="licensing"), +] + urlpatterns = [ path("", views.IndexPageView.as_view(), name="index"), - path("privacy/", views.PrivacyPageView.as_view(), name="privacy"), path( "accounts/register/", RegistrationView.as_view(form_class=RegistrationForm), @@ -45,13 +51,13 @@ path("accounts/", include("django.contrib.auth.urls")), path("accounts/", include(accounts_patterns)), path("about/", views.AboutPageView.as_view(), name="about"), - path("terms/", views.TermsPageView.as_view(), name="terms"), path( "terms-acceptance/", views.TermsAcceptanceView.as_view(), name="terms_acceptance", ), path("framework/", include(framework_patterns)), + path("policies/", include(policies_patterns)), path("get-involved/", views.GetInvolvedPageView.as_view(), name="get_involved"), path("events/", views.EventsPageView.as_view(), name="events"), path("framework-json/", views.FrameworkView.as_view(), name="framework_json"), diff --git a/main/views/page_views.py b/main/views/page_views.py index 49e9dfe6..e3273a25 100644 --- a/main/views/page_views.py +++ b/main/views/page_views.py @@ -6,10 +6,16 @@ from collections.abc import Mapping from json import dumps from pathlib import Path -from typing import Any +from typing import Any, ClassVar +import markdown +import nh3 +import requests from django.shortcuts import get_object_or_404 from django.templatetags.static import static +from django.utils.decorators import method_decorator +from django.utils.safestring import mark_safe +from django.views.decorators.cache import cache_page from django.views.generic.base import TemplateView from django_tables2 import SingleTableView @@ -65,7 +71,7 @@ def get_context_data(self, **kwargs: Mapping[str, Any]) -> dict[str, Any]: class PrivacyPageView(TemplateView): """View that renders the privacy page.""" - template_name = "main/pages/privacy.html" + template_name = "main/pages/policies/privacy.html" class AboutPageView(TemplateView): @@ -77,7 +83,7 @@ class AboutPageView(TemplateView): class TermsPageView(TemplateView): """View that renders the terms and conditions page.""" - template_name = "main/pages/terms.html" + template_name = "main/pages/policies/terms.html" class SkillLevelsPageView(TemplateView): @@ -222,3 +228,85 @@ class FrameworkOverviewPageView(TemplateView): """View that renders an overview page for the framework.""" template_name = "main/pages/framework-overview.html" + + +class GitHubMarkdownPageView(TemplateView): + """Base view for pages that render markdown content fetched from GitHub.""" + + github_raw_url = "" + page_heading = "" + unavailable_message = "Document is temporarily unavailable." + markdown_extensions: ClassVar[list[str]] = ["fenced_code", "tables", "toc"] + + def _strip_duplicate_heading(self, markdown_text: str) -> str: + """Remove leading H1 if it duplicates the configured page heading.""" + lines = markdown_text.splitlines() + if not lines: + return markdown_text + + first_line = lines[0].strip() + if self.page_heading not in first_line: + return markdown_text + + # Remove the duplicate title line and one following blank line if present. + del lines[0] + if lines and lines[0].strip() == "": + del lines[0] + + return "\n".join(lines) + + def get_markdown_content(self) -> str: + """Fetch and convert remote markdown content to HTML.""" + if not self.github_raw_url: + raise ValueError("github_raw_url must be set on GitHubMarkdownPageView") + + response = requests.get(self.github_raw_url, timeout=5) + response.raise_for_status() + markdown_text = self._strip_duplicate_heading(response.text) + return markdown.markdown( + markdown_text, + extensions=self.markdown_extensions, + ) + + def get_context_data(self, **kwargs: Mapping[str, Any]) -> dict[str, Any]: + """Add rendered markdown content and page metadata to the context.""" + context = super().get_context_data(**kwargs) + context["page_heading"] = self.page_heading + + try: + context["markdown_content"] = mark_safe( + nh3.clean(self.get_markdown_content()) + ) + except requests.RequestException: + logger.exception("Failed to load markdown from %s", self.github_raw_url) + context["markdown_content"] = mark_safe( + f"

      {self.unavailable_message}

      " + ) + + return context + + +@method_decorator(cache_page(60 * 60), name="dispatch") # cache 1 hour +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" + ) diff --git a/pyproject.toml b/pyproject.toml index 845e9f44..17f76c63 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -18,7 +18,10 @@ dependencies = [ "mysqlclient", "django-import-export", "django-multiselectfield", - "django-tables2" + "django-tables2", + "markdown", + "nh3", + "requests" ] [project.optional-dependencies] @@ -34,6 +37,8 @@ dev = [ "django-stubs[compatible-mypy]", "djlint", "types-django-import-export", + "types-Markdown", + "types-requests", "beautifulsoup4", ] doc = [ diff --git a/requirements.txt b/requirements.txt index 9b1e606a..39dfe18a 100644 --- a/requirements.txt +++ b/requirements.txt @@ -6,6 +6,10 @@ # asgiref==3.11.1 # via django +certifi==2026.4.22 + # via requests +charset-normalizer==3.4.7 + # via requests confusable-homoglyphs==3.3.1 # via django-registration crispy-bootstrap5==2026.3 @@ -41,15 +45,25 @@ django-tables2==3.0.0 # via direct_webapp (pyproject.toml) gunicorn==25.3.0 # via direct_webapp (pyproject.toml) +idna==3.13 + # via requests +markdown==3.10.2 + # via direct_webapp (pyproject.toml) mysqlclient==2.2.8 # via direct_webapp (pyproject.toml) +nh3==0.3.4 + # via direct_webapp (pyproject.toml) packaging==26.0 # via gunicorn +requests==2.33.1 + # via direct_webapp (pyproject.toml) sqlparse==0.5.5 # via django tablib==3.9.0 # via django-import-export typing-extensions==4.15.0 # via django-stubs-ext +urllib3==2.6.3 + # via requests whitenoise==6.12.0 # via direct_webapp (pyproject.toml) diff --git a/tests/main/test_main_views.py b/tests/main/test_main_views.py index ec4f63d5..8082cdaa 100644 --- a/tests/main/test_main_views.py +++ b/tests/main/test_main_views.py @@ -13,11 +13,7 @@ from django.urls import reverse from pytest_django.asserts import assertTemplateUsed -from main.models import ( - Skill, - SkillLevel, - UserSkill, -) +from main.models import Skill, SkillLevel, UserSkill from main.views.page_views import _extract_and_combine_roles from .view_utils import ( @@ -82,7 +78,7 @@ def test_navbar_contents(self, soup, auth_soup, admin_soup): href=reverse("learning_resources"), ) assert framework_dropdown.find( - tag_with_text_filter("a", "Roles and job profiles"), href=reverse("roles") + tag_with_text_filter("a", "Roles & career pathways"), href=reverse("roles") ) # Community Dropdown @@ -149,7 +145,7 @@ def test_navbar_contents_when_authenticated(self, auth_soup, admin_soup): class TestPrivacy(TemplateOkMixin): """Test suite for the privacy view.""" - _template_name = "main/pages/privacy.html" + _template_name = "main/pages/policies/privacy.html" def _get_url(self): return reverse("privacy") @@ -212,7 +208,7 @@ def test_page_content(self, soup): class TestTermsPageView(TemplateOkMixin): """Test suite for the TermsPageView.""" - _template_name = "main/pages/terms.html" + _template_name = "main/pages/policies/terms.html" def _get_url(self): return reverse("terms") @@ -540,9 +536,27 @@ def test_extract_and_combine_roles(): class TestFrameworkOverviewPageView(TemplateOkMixin): - """Test suite for the GetInvolvedPageView.""" + """Test suite for the FrameworkOverviewPageView.""" _template_name = "main/pages/framework-overview.html" def _get_url(self): return reverse("framework_overview") + + +class TestGovernancePageView(TemplateOkMixin): + """Test suite for the GovernancePageView.""" + + _template_name = "main/pages/policies/governance.html" + + def _get_url(self): + return reverse("governance") + + +class TestLicensingPageView(TemplateOkMixin): + """Test suite for the LicensingPageView.""" + + _template_name = "main/pages/policies/licensing.html" + + def _get_url(self): + return reverse("licensing")