From 9509d6409f45192cb47df6888cee5e7aa2ab1ece Mon Sep 17 00:00:00 2001 From: Clifford Gama Date: Fri, 15 Nov 2024 09:26:01 +0200 Subject: [PATCH] Clarify get_context() usage in BlogTagIndexPage example (#12573) --- CHANGELOG.txt | 1 + CONTRIBUTORS.md | 1 + docs/getting_started/tutorial.md | 4 ++-- docs/releases/6.4.md | 1 + 4 files changed, 5 insertions(+), 2 deletions(-) diff --git a/CHANGELOG.txt b/CHANGELOG.txt index 7c36db236d..046e5d46e8 100644 --- a/CHANGELOG.txt +++ b/CHANGELOG.txt @@ -34,6 +34,7 @@ Changelog * Docs: Replace absolute URLs with intersphinx links where possible to avoid broken links (Sage Abdullah) * Docs: Update upgrading guide and release process to better reflect the current practices (Sage Abdullah) * Docs: Document usage of custom validation for admin form pages when using `AbstractEmailForm` or `AbstractForm` pages (John-Scott Atlakson, LB (Ben) Johnston) + * Docs: Reword `BlogTagIndexPage` example for clarity (Clifford Gama) * Maintenance: Close open files when reading within utils/setup.py (Ataf Fazledin Ahamed) * Maintenance: Avoid redundant `ALLOWED_HOSTS` check in `Site.find_for_request` (Jake Howard) * Maintenance: Update `CloneController` to ensure that `added`/`cleared` events are not dispatched as cancelable (LB (Ben) Johnston) diff --git a/CONTRIBUTORS.md b/CONTRIBUTORS.md index c25aa9488e..6def6e9915 100644 --- a/CONTRIBUTORS.md +++ b/CONTRIBUTORS.md @@ -854,6 +854,7 @@ * manu * Aayushman Singh * Steven Steinwand +* Clifford Gama ## Translators diff --git a/docs/getting_started/tutorial.md b/docs/getting_started/tutorial.md index e08343afc9..5d96506156 100644 --- a/docs/getting_started/tutorial.md +++ b/docs/getting_started/tutorial.md @@ -921,8 +921,8 @@ class BlogTagIndexPage(Page): Note that this Page-based model defines no fields of its own. Even without fields, subclassing `Page` makes it a part of the Wagtail ecosystem, so that you can give it a title and URL in the -admin, and so that you can manipulate its contents by returning -a QuerySet from its `get_context()` method. +admin. You can also override its `get_context()` method to add a +QuerySet to the context dictionary, making it available to the template. Migrate this by running `python manage.py makemigrations` and then `python manage.py migrate`. After migrating the new changes, create a new `BlogTagIndexPage` in the admin interface. To create the `BlogTagIndexPage`, follow the same process you followed in creating the `BlogIndexPage` and give it the slug "tags" on the Promote tab. This means the `BlogTagIndexPage` is a child of the home page and parallel to `Our Blog` in the admin interface. diff --git a/docs/releases/6.4.md b/docs/releases/6.4.md index cad15e8054..1f5ba897b5 100644 --- a/docs/releases/6.4.md +++ b/docs/releases/6.4.md @@ -50,6 +50,7 @@ depth: 1 * Replace absolute URLs with intersphinx links where possible to avoid broken links (Sage Abdullah) * Update upgrading guide and release process to better reflect the current practices (Sage Abdullah) * Document usage of [Custom validation for admin form pages](form_builder_custom_admin_validation) when using `AbstractEmailForm` or `AbstractForm` pages (John-Scott Atlakson, LB (Ben) Johnston) + * Reword `BlogTagIndexPage` example for clarity (Clifford Gama) ### Maintenance