CMS: Landing Page Header Updates (#3027)

* CMS: Landing Page Header Updates

* CMS: Update tests and landing page related files

---------

Co-authored-by: Luke Towell <luke.towell@ukhsa.gov.uk>
Co-authored-by: phill-stanley <139551113+phill-stanley@users.noreply.github.com>

Author: 3 people

cms/common/models.py

@@ -2,8 +2,6 @@
 from modelcluster.fields import ParentalKey
 from wagtail.admin.panels import FieldPanel, InlinePanel, ObjectList, TabbedInterface
 from wagtail.api import APIField
-from wagtail.fields import RichTextField
-from wagtail.models import Orderable
 from wagtail.search import index
 
 from cms.common.managers import CommonPageManager
@@ -12,8 +10,8 @@
     RelatedLinksLayoutEnum,
 )
 from cms.dashboard.models import (
-    MAXIMUM_URL_FIELD_LENGTH,
     UKHSAPage,
+    UKHSAPageRelatedLink,
 )
 from cms.dynamic_content import help_texts
 from cms.dynamic_content.announcements import Announcement
@@ -66,27 +64,10 @@ def is_previewable(cls) -> bool:
         return False
 
 
-class CommonPageRelatedLink(Orderable):
+class CommonPageRelatedLink(UKHSAPageRelatedLink):
     page = ParentalKey(
         CommonPage, on_delete=models.SET_NULL, null=True, related_name="related_links"
     )
-    title = models.CharField(max_length=255)
-    url = models.URLField(verbose_name="URL", max_length=MAXIMUM_URL_FIELD_LENGTH)
-    body = RichTextField(features=[])
-
-    # Sets which panels to show on the editing view
-    panels = [
-        FieldPanel("title"),
-        FieldPanel("url"),
-        FieldPanel("body"),
-    ]
-
-    # Sets which fields to expose on the API
-    api_fields = [
-        APIField("title"),
-        APIField("url"),
-        APIField("body"),
-    ]
 
 
 class CommonPageAnnouncement(Announcement):

cms/composite/models.py

@@ -6,16 +6,14 @@
 from wagtail.admin.panels import FieldPanel, InlinePanel, ObjectList, TabbedInterface
 from wagtail.api import APIField
 from wagtail.fields import RichTextField
-from wagtail.models import Orderable
 from wagtail.search import index
 
-from cms.common.models import MAXIMUM_URL_FIELD_LENGTH
 from cms.composite.managers import CompositePageManager
 from cms.dashboard.enums import (
     DEFAULT_RELATED_LINKS_LAYOUT_FIELD_LENGTH,
     RelatedLinksLayoutEnum,
 )
-from cms.dashboard.models import UKHSAPage
+from cms.dashboard.models import UKHSAPage, UKHSAPageRelatedLink
 from cms.dynamic_content import help_texts
 from cms.dynamic_content.access import ALLOWABLE_BODY_CONTENT_COMPOSITE
 from cms.dynamic_content.announcements import Announcement
@@ -118,31 +116,15 @@ def last_updated_at(self) -> datetime.datetime:
         return max(timestamps)
 
 
-class CompositeRelatedLink(Orderable):
+class CompositeRelatedLink(UKHSAPageRelatedLink):
     page = ParentalKey(
         CompositePage,
         on_delete=models.SET_NULL,
         null=True,
         related_name="related_links",
     )
-    title = models.CharField(max_length=255)
-    url = models.URLField(verbose_name="URL", max_length=MAXIMUM_URL_FIELD_LENGTH)
     body = RichTextField(features=[], blank=True)
 
-    # Sets which panels to show on the editing view
-    panels = [
-        FieldPanel("title"),
-        FieldPanel("url"),
-        FieldPanel("body"),
-    ]
-
-    # Sets which fields to expose on the API
-    api_fields = [
-        APIField("title"),
-        APIField("url"),
-        APIField("body"),
-    ]
-
 
 class CompositePageAnnouncement(Announcement):
     page = ParentalKey(

cms/dashboard/management/commands/build_cms_site_helpers/pages.py

@@ -15,6 +15,7 @@
 )
 from cms.forms.models import FormField, FormPage
 from cms.home.models import LandingPage
+from cms.home.models.landing_page import LandingPageRelatedLink
 from cms.snippets.data_migrations.operations import (
     get_or_create_download_button_internal_button_snippet,
 )
@@ -57,13 +58,21 @@ def create_landing_page(*, parent_page: Page) -> LandingPage:
     page = LandingPage(
         title=data["title"],
         sub_title=data["sub_title"],
+        page_description=data["page_description"],
         body=landing_page_body,
+        related_links_layout=data["related_links_layout"],
         slug=data["meta"]["slug"],
         seo_title=data["meta"]["seo_title"],
         search_description=data["meta"]["search_description"],
     )
     _add_page_to_parent(page=page, parent_page=parent_page)
 
+    _create_related_links(
+        related_link_class=LandingPageRelatedLink,
+        response_data=data,
+        page=page,
+    )
+
     return page
 
 

cms/dashboard/models.py

@@ -8,7 +8,7 @@
 from wagtail.admin.panels import FieldPanel, InlinePanel, MultiFieldPanel
 from wagtail.api import APIField
 from wagtail.fields import RichTextField
-from wagtail.models import Page, SiteRootPath
+from wagtail.models import Orderable, Page, SiteRootPath
 
 from cms import seo
 
@@ -163,3 +163,37 @@ def active_announcements(self) -> list[dict[str, str | int]]:
             .order_by("-banner_type")
             .values("id", "title", "body", "banner_type")
         )
+
+
+class UKHSAPageRelatedLink(Orderable):
+    """
+    Abstract base class for all page types related links.
+
+    When a page type extends this class, it will need to include the `page` field e.g.
+
+    page = ParentalKey(
+        <PAGE_TYPE>, on_delete=models.SET_NULL, null=True, related_name="related_links"
+    )
+    """
+
+    title = models.CharField(max_length=255)
+    url = models.URLField(verbose_name="URL", max_length=MAXIMUM_URL_FIELD_LENGTH)
+    body = RichTextField(features=[])
+
+    # Sets which panels to show on the editing view
+    panels = [
+        FieldPanel("title"),
+        FieldPanel("url"),
+        FieldPanel("body"),
+    ]
+
+    # Sets which fields to expose on the API
+    api_fields = [
+        APIField("title"),
+        APIField("url"),
+        APIField("body"),
+    ]
+
+    class Meta:
+        abstract = True
+        ordering = ["sort_order"]

cms/dashboard/templates/cms_starting_pages/landing_page.json

@@ -22,7 +22,10 @@
     },
     "title": "Landing page",
     "sub_title": "showing public health data across England",
+    "page_description": "",
     "body": "",
+    "related_links": [],
+    "related_links_layout": "Footer",
     "last_published_at": "2024-09-20T14:04:30.332316+01:00",
     "last_updated_at": "2024-09-24T16:40:55.228390+01:00",
     "seo_change_frequency": 5,

cms/home/migrations/0028_landingpage_page_description_and_more.py

@@ -0,0 +1,75 @@
+# Generated by Django 5.2.9 on 2026-02-25 12:31
+
+import django.db.models.deletion
+import modelcluster.fields
+import wagtail.fields
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("home", "0027_alter_landingpage_new_chart_row_blocks"),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name="landingpage",
+            name="page_description",
+            field=wagtail.fields.RichTextField(
+                blank=True,
+                help_text="\nAn optional body of text which will be rendered at the top of the page. \nThis text will be displayed after the title of the page and before any of the main content.\n",
+                null=True,
+            ),
+        ),
+        migrations.AddField(
+            model_name="landingpage",
+            name="related_links_layout",
+            field=models.CharField(
+                choices=[("Sidebar", "Sidebar"), ("Footer", "Footer")],
+                default="Footer",
+                help_text="\nThis dictates where the related links for this page will be positioned.\n",
+                max_length=10,
+                verbose_name="Layout",
+            ),
+        ),
+        migrations.AlterField(
+            model_name="landingpage",
+            name="sub_title",
+            field=models.CharField(blank=True, max_length=255, null=True),
+        ),
+        migrations.CreateModel(
+            name="LandingPageRelatedLink",
+            fields=[
+                (
+                    "id",
+                    models.BigAutoField(
+                        auto_created=True,
+                        primary_key=True,
+                        serialize=False,
+                        verbose_name="ID",
+                    ),
+                ),
+                (
+                    "sort_order",
+                    models.IntegerField(blank=True, editable=False, null=True),
+                ),
+                ("title", models.CharField(max_length=255)),
+                ("url", models.URLField(max_length=400, verbose_name="URL")),
+                ("body", wagtail.fields.RichTextField()),
+                (
+                    "page",
+                    modelcluster.fields.ParentalKey(
+                        null=True,
+                        on_delete=django.db.models.deletion.SET_NULL,
+                        related_name="related_links",
+                        to="home.landingpage",
+                    ),
+                ),
+            ],
+            options={
+                "ordering": ["sort_order"],
+                "abstract": False,
+            },
+        ),
+    ]

cms/home/models/landing_page.py

@@ -1,10 +1,20 @@
 from django.db import models
 from modelcluster.fields import ParentalKey
-from wagtail.admin.panels import FieldPanel, ObjectList, TabbedInterface
+from wagtail.admin.panels import FieldPanel, InlinePanel, ObjectList, TabbedInterface
 from wagtail.api import APIField
+from wagtail.fields import RichTextField
 from wagtail.models import Page
 
-from cms.dashboard.models import UKHSAPage
+from cms.dashboard.enums import (
+    DEFAULT_RELATED_LINKS_LAYOUT_FIELD_LENGTH,
+    RelatedLinksLayoutEnum,
+)
+from cms.dashboard.models import (
+    AVAILABLE_RICH_TEXT_FEATURES,
+    UKHSAPage,
+    UKHSAPageRelatedLink,
+)
+from cms.dynamic_content import help_texts
 from cms.dynamic_content.access import ALLOWABLE_BODY_CONTENT_SECTION_LINK
 from cms.dynamic_content.announcements import Announcement
 from cms.home.managers import LandingPageManager
@@ -13,22 +23,49 @@
 class LandingPage(UKHSAPage):
     is_creatable = True
     max_count = 1
-    sub_title = models.CharField(max_length=255)
+    sub_title = models.CharField(max_length=255, null=True, blank=True)
+    page_description = RichTextField(
+        features=AVAILABLE_RICH_TEXT_FEATURES,
+        blank=True,
+        null=True,
+        help_text=help_texts.PAGE_DESCRIPTION_FIELD,
+    )
     body = ALLOWABLE_BODY_CONTENT_SECTION_LINK
 
-    content_panels = Page.content_panels + [FieldPanel("sub_title"), FieldPanel("body")]
+    related_links_layout = models.CharField(
+        verbose_name="Layout",
+        help_text=help_texts.RELATED_LINKS_LAYOUT_FIELD,
+        default=RelatedLinksLayoutEnum.Footer.value,
+        max_length=DEFAULT_RELATED_LINKS_LAYOUT_FIELD_LENGTH,
+        choices=RelatedLinksLayoutEnum.choices(),
+    )
+
+    sidebar_content_panels = [
+        FieldPanel("related_links_layout"),
+        InlinePanel("related_links", heading="Related links", label="Related link"),
+    ]
+
+    content_panels = Page.content_panels + [
+        FieldPanel("sub_title"),
+        FieldPanel("page_description"),
+        FieldPanel("body"),
+    ]
 
     api_fields = UKHSAPage.api_fields + [
         APIField("title"),
         APIField("sub_title"),
+        APIField("page_description"),
         APIField("body"),
+        APIField("related_links_layout"),
+        APIField("related_links"),
         APIField("search_description"),
         APIField("last_published_at"),
     ]
 
     edit_handler = TabbedInterface(
         [
             ObjectList(content_panels, heading="Content"),
+            ObjectList(sidebar_content_panels, heading="Related Links"),
             ObjectList(UKHSAPage.announcement_content_panels, heading="Announcements"),
             ObjectList(UKHSAPage.promote_panels, heading="Promote"),
         ]
@@ -81,3 +118,9 @@ class LandingPageAnnouncement(Announcement):
         null=True,
         related_name="announcements",
     )
+
+
+class LandingPageRelatedLink(UKHSAPageRelatedLink):
+    page = ParentalKey(
+        LandingPage, on_delete=models.SET_NULL, null=True, related_name="related_links"
+    )

cms/topic/models.py

@@ -5,7 +5,6 @@
 from wagtail.admin.panels import FieldPanel, InlinePanel, ObjectList, TabbedInterface
 from wagtail.api import APIField
 from wagtail.fields import RichTextField
-from wagtail.models import Orderable
 from wagtail.search import index
 
 from cms.dashboard.enums import (
@@ -14,8 +13,8 @@
 )
 from cms.dashboard.models import (
     AVAILABLE_RICH_TEXT_FEATURES,
-    MAXIMUM_URL_FIELD_LENGTH,
     UKHSAPage,
+    UKHSAPageRelatedLink,
 )
 from cms.dynamic_content import help_texts
 from cms.dynamic_content.access import ALLOWABLE_BODY_CONTENT
@@ -204,27 +203,10 @@ def last_updated_at(self) -> datetime.datetime:
         return max(timestamps)
 
 
-class TopicPageRelatedLink(Orderable):
+class TopicPageRelatedLink(UKHSAPageRelatedLink):
     page = ParentalKey(
         TopicPage, on_delete=models.SET_NULL, null=True, related_name="related_links"
     )
-    title = models.CharField(max_length=255)
-    url = models.URLField(verbose_name="URL", max_length=MAXIMUM_URL_FIELD_LENGTH)
-    body = RichTextField(features=[])
-
-    # Sets which panels to show on the editing view
-    panels = [
-        FieldPanel("title"),
-        FieldPanel("url"),
-        FieldPanel("body"),
-    ]
-
-    # Sets which fields to expose on the API
-    api_fields = [
-        APIField("title"),
-        APIField("url"),
-        APIField("body"),
-    ]
 
 
 class TopicPageAnnouncement(Announcement):