Wagtail

Wagtail, the opinionated best practice.

Docker Image

$ docker build -t hbrls/wagtail:{version} .

For most of the time, you will continue to install app-specific dependencies. So I left the USER root there.

Before start your final app, you should set it to USER www-data.

RUN sed "s/#logformat/$(cat /path/to/uwsgi-logformat.yaml)/" /uwsgi.yaml to use your customized logformat.

Best Practice

1. Initialized database

   $ mysql> CREATE DATABASE wagtailexample CHARACTER SET utf8mb4 COLLATE utf8mb4_general_ci;
   $ mysql> CREATE USER 'wagtailexample'@'%' IDENTIFIED BY 'wagtailexample';
   $ mysql> GRANT ALL PRIVILEGES ON wagtailexample.* TO 'wagtailexample'@'%'
   $ mysql> FLUSH PRIVILEGES;
   
   $ wagtail start appl
   
   $ python manage.py makemigrations
   $ python manage.py migrate
   
   $ python manage.py createsuperuser  # wagtail:wagtail, wagtail@wagtailexample.com
   
   $ python manage.py collectstatic

2. Change the default home page to our own ~/home/models.IndexPage.

   1. 在 Welcome to wagtail 下新建 IndexPage，然后将它转移到 Root 下
   2. 到 "设置 > 站点 > Root Page" 将默认首页设置为 IndexPage

3. Add example of page/subpage hierarchy

   Root
       Welcome to wagtail
       首页                 <- the de facto root
           博客文章列表
               博客文章列表
               一类文章
               二类文章
           关于我们
   

4. Add example of WhateverPage and AgreementPage. The Hallo.js Wagtail 1.5.3 is using doesn't support <h1>. Waiting for the next major release.

Where you are supposed to move on?

1. "设置 > 站点"

Conventions

1. ~/templates for templates.

2. ~/static is the destination of assets.

3. DJANGO_ENV: 'dev', 'sit', 'prod', ... to distinguish deploy environments.

4. The code (e.g. ~/home/models.py, ~/blog/models.py) provide Page Types to be used. The structure (i.e. site map) is up to your settings from the admin panel.

5. You would be requested a bunch of carefully-designed-hard-coded-pages. Just list their empty classes in ~/home/models.py (e.g. About) and do the hard code and admin panel settings.

6. For do-whatever-you-like pages, just choose ~/home/models.Whatever in the admin panel. You can also customize your own class like ~/home/models.Agreement for a set of similar whatever pages.

Dependencies

package	version	date
Wagtail	5.2.3, LTS	2024-01-23
Django	4.2.9, LTS	2024-01-02
Pydantic	2.5.3	2023-12-22
Django-Ninja	1.0.1	2023-11-17
Jinja2	3.1.2	2022-04-28
MarkupSafe	2.1.3	2023-06-03
django-rest-framework	3.14.0	2022-11-08
django-modelcluster	6.2.1	2024-01-04
django-taggit	4.0.0	2023-05-04
django-treebeard	4.7.1	2024-01-31
django-filter	23.5	2023-12-05
beautifulsoup4	4.12.3	2024-01-18
Pillow	10.2.0	2024-01-02
pillow_heif	0.13.1	2023-10-15
Willow	1.6.3	2023-11-26
requests	2.31.0	2023-05-22

1. Pillow
   1. Pillow vs Python
   2. Pillow vs Platform

References

1. https://github.com/apihackers/docker-wagtail
2. Official: Your first Wagtail site
3. Official: Wagtail demo project

Django 101

Django LTS Roadmap

Wagtail LTS Roadmap

$ python manage.py showmigrations --plan
$ python manage.py sqlmigrate {app_name} {migration_name}
$ python manage.py migrate {app_name} {migration_name} --fake

CHANGELOG

2.9.3

1. Wagtail/Django renamed or deprecated contrib packages; examples
2. Django breaking changes 1, 2

2.15.6, LTS, 2022-09-05

1. Django@3.0.14, 2021-04-06, claims to support Python@3.9 at v2.2.17, which is not true
2. PyMySQL@1.0.0, 2021-01-07, to replace mysqlclient
3. Pillow@8.1.2, 2021-03-06
4. Wagtail@2.11
   1. SiteMiddleware moved to wagtail.contrib.legacy

3.0.3, 2022-09-05

1. Django@3.2.6, 2022-10-04
2. drops Django@3.1, Python@3.6

4.1.9, LTS, 2023-10-19

1. Django@4.1.10, 2023-07-03
2. ImageChooserPanel -> FieldPanel

5.0.5, 2023-10-19

1. Pillow==9.1.0, Willow==1.5
2. wagtail.core deprecated

5.2.3, LTS, 2024-01-23

1. Django@4.2 强制要求 MySQL@8