Checklist: theme launch #

This page is for designers and project managers before a design goes live. Each line links to the page that explains it. Copy it into your ticket and tick it off.

Contents #

1. Structure and settings
2. Templates
3. Assets
4. Quality
5. The switch-over

Structure and settings #

• To do: The design lives in its own extension, registered with DesignExtensions[] (Design extensions).
• To do: ezinfo.php and extension.xml carry the same version, license and name (ezinfo.php).
• To do: The siteaccess's design chain is intentional and short (The design cascade).
• To do: Override rules have prefixed, unique section names and, where order matters, a Priority.
• To do: No node ids in settings or overrides that differ between installations; remote ids or classes instead.
• To do: No secrets in the extension (keys, passwords, hostnames of databases).

Templates #

• To do: ./console exp:eztemplatecheck <design>/templates/ reports every file valid (Debugging a design).
• To do: Every printed value is washed (Wash and escaping).
• To do: Every interface text goes through i18n with the theme's context.
• To do: Every list fetch has a limit; no fetch inside a loop.
• To do: Cache-blocks have the right keys; nothing user-specific in view-cached templates (Caching for designers).
• To do: No <style>, style="", inline scripts or handler attributes (Checklist: CSP).

Assets #

• To do: One ezcss_load, scripts at the end of the body or deferred (Loading stylesheets).
• To do: Fonts self-hosted with licenses shipped (Fonts in a design).
• To do: Favicons and touch icons (Favicons and touch icons).
• To do: Image aliases defined for the sizes shown (Image aliases).
• To do: No third-party request before consent (External resources and CDNs).

Quality #

• To do: Checklist: accessibility passed.
• To do: Checklist: dark mode passed (if the design has one).
• To do: Checklist: right to left passed (if the site has such languages).
• To do: Checklist: performance passed.
• To do: Every page type checked at 1440 px, 960 px with scale 2, and 375 px.
• To do: Print preview of an article is readable.
• To do: Error pages (not found, no access) and the search page are styled.

The switch-over #

• To do: Tested on a preview siteaccess against real content (Previewing a design on a siteaccess).
• To do: Development settings off on the live siteaccess (DevelopmentMode, ShowTemplatePathComments, debug output).
• To do: Caches cleared after the switch, packer included (The packer cache and deploys).
• To do: The most visited pages opened signed out right after the switch.
• To do: A way back: the old SiteDesign values written down.

Related pages #

• Checklist: code review for templates
• Checklist: the theme extension is ready
• Free documentation: this page is free to copy, translate and improve under the GNU FDL 1.3.