Platform upgrades page¶
The admin page where a shop applies platform upgrades (/admin/upgrades). What it does and how it
works are in Platform Upgrades. This page records the
design decisions.
Why it changed¶
The page started as one card per upgrade, all the same size, in the order they were written. With eleven upgrades it meant a lot of scrolling, applied and unapplied cards looked alike, and nothing said which ones a shop actually needed. A restaurant upgrade got as much space as the cookie banner, and the home page counted both as waiting.
Decisions¶
- State first. The page opens with one line ("3 upgrades to deal with" or "Your site is up to date"), the progress bar and four counts that link to the lists. Someone opening the page sees where they stand without scrolling.
- Lists in working order. Needs your attention, To apply, Optional, Done. Each list is a card with a sentence saying what it is and what to do. Empty lists aren't shown.
- Importance is data on the upgrade, not something the page guesses. Compliance sorts first and has the warning badge; optional upgrades say who they're for. Optional ones never count as waiting, so the home page link only appears when there's something the shop should do.
- Done is folded. Applied upgrades are history. They sit in a
<details>with who applied them and when, and only open by themselves when nothing else is left. An upgrade whose apply asked for a check keeps an exclamation mark and its steps there, rather than staying in "Needs your attention" forever: the upgrade itself reads as applied. - Same rows as Finish setting up. The rows reuse the
bx-setuplist: the round mark, the greyed waiting row with a lock, Not needed and Put back. A merchant who knows one list knows the other. - Waiting instead of a button. An upgrade that builds on another shows "Apply … first." and no Apply button, and the server refuses it too, so it can't half-run.
- Release notes on demand. "What this changes" is a fold in each row, so the list stays a list.
- The result names its upgrade. After an apply the upgrade may move to another list (or into the folded Done list), so the message at the top starts with the upgrade's title.
- Plain forms, no script. Apply, Not needed and Put back are POST forms that come back to the page.
Rules a later change must keep¶
- A new upgrade sets
importance(), and an optional one setsaudience(). Without them it lands in To apply and counts as waiting for every shop. - Progress counts done against done plus outstanding, leaving out optional upgrades not taken up and ones marked not needed.
- Row text speaks to the merchant: no class names, config keys or statuses.