Show staff what changed after an update closes #683 #692

Merged
simon merged 16 commits from issue/mitgliederverwaltung-683 into main 2026-11-19 00:13:43 +01:00
Owner

closes #683

Description of the implemented changes

The changes were:

  • Bugfixing
  • New Feature
  • Breaking Change
  • Refactoring

Staff now see what changed in Mila on a page "What's new", reached from an entry right above the sidebar footer. The page lists the changes of the last five releases that concern the person's role, newest first, each with a link to the exact place it is about. A change that asks someone to act is a task: it is marked "Open", counted on the sidebar entry ("2 open", a number on the icon when the sidebar is collapsed) and shown as a hint at its place ("New: …" with "All news" and "Done") until the person marks it as done, one by one or all at once with "Undo". Unread changes without a task are counted as "N new" until the page is opened. Members do not see any of it.

Each release's changes are a data file (priv/whats_new/<version>.exs), read and checked at compile time: literals only, at most five entries, unique ids, known areas and permission sets, a task needs a link, a hint needs a task. This PR ships the files for 1.5.0 and 1.6.0 and the rule for writing them (docs/whats-new.md, a step in docs/releasing.md).

What has been changed?

  • Read the changes of each release from checked data files
  • Keep each user's what's new state, starting existing accounts on 1.4.0
  • Add the what's new page and a sidebar entry counting open and new changes
  • Keep jump targets clear of the sticky top bar
  • Mark all open what's new tasks as done at once, with undo
  • Focus and briefly outline the section a link jumps to
  • Show an open what's new task as a hint at the place it is about
  • Describe the dot on the join requests entry to screen readers
  • Add the rules for what's new entries, hints, sidebar markers and jump targets
  • Note what's new and that existing accounts start at 1.4.0 in the changelog
  • Show the admission and rejection emails side by side in the settings
  • Build the icon markers from daisyUI indicator, badge and status
  • Add a view dialog that only shows content, closed with Close
  • Open the email preview in a dialog next to Save and line up both cards
  • Explain the emails to applicants in a note below them instead of a callout
  • Make Save the primary action of each email paragraph form

Definition of Done

Code Quality

  • No new technical depths
  • Linting passed
  • Documentation is added were needed

Accessibility

  • New elements are properly defined with html-tags
  • Colour contrast follows WCAG criteria
  • Aria labels are added when needed
  • Everything is accessible by keyboard
  • Tab-Order is comprehensible
  • All interactive elements have a visible focus

Testing

  • Tests for new code are written
  • All tests pass
  • axe-core dev tools show no critical or major issues

Additional Notes

  • State per user (users.whats_new_since, whats_new_seen_version, whats_new_done): the migration starts existing accounts at 1.4.0, so 1.5.0 and 1.6.0 show as new once; new accounts start at the running version. Only a release build shows anything as new or open; a development build and a downgrade show nothing.
  • No free input: the four user actions take no version and accept only ids of tasks the user sees. Who sees an entry depends on the pages a role may open, which the web layer knows, so the domain asks it through the Mv.WhatsNew.Visibility behaviour (configured like :join_notifier). Done and Undo compute the list from the stored row, locked in the action's transaction, so two tabs or devices keep each other's done tasks. Forged ids, another person's state and members are refused (tests send them).
  • Hint at the place: an on_mount hook (MvWeb.WhatsNewHint) keeps the hint for the current path and handles its "Done" on every page; a page shows it with <.whats_new_hint> where the task's link lands. A data test fails for a hint no page shows. <.callout> gained title and actions for it (showcase variant added).
  • Jump targets: scroll-padding-top on html never saw the top bar height (the variable was declared on a descendant), so every #section link put the heading under the sticky bar; fixed on its own commit. Every jump now focuses the section's heading and outlines it for about 3 s (no fade with reduced motion). There is no browser test layer; this was checked in Chromium and Firefox, desktop and phone.
  • Settings, emails to applicants: the two emails sit side by side as equal cards; the preview opens in a new view dialog (<.modal kind={:view}>: only Close, backdrop closes, wide enough for a 600 px email); a note below both cards replaces the info callout.
  • Sidebar: the join requests dot is now described to screen readers ("Unprocessed requests"); counts and dots follow one rule and are built from daisyUI indicator, badge and status (DESIGN_GUIDELINES §21.2); the hand-positioned .nav-count is gone.

The CHANGELOG has an upgrade note: existing accounts start at 1.4.0 and see 1.5.0 and 1.6.0 as new; admins and the board have one open task each.

Proposed news entry: none for this feature. The newest data file in this PR already holds five entries (the limit), all about changes that ask something of a role; "What's new" introduces itself through its sidebar count on the first sign-in after the update.

closes #683 ## Description of the implemented changes The changes were: - [x] Bugfixing - [x] New Feature - [ ] Breaking Change - [ ] Refactoring Staff now see what changed in Mila on a page "What's new", reached from an entry right above the sidebar footer. The page lists the changes of the last five releases that concern the person's role, newest first, each with a link to the exact place it is about. A change that asks someone to act is a task: it is marked "Open", counted on the sidebar entry ("2 open", a number on the icon when the sidebar is collapsed) and shown as a hint at its place ("New: …" with "All news" and "Done") until the person marks it as done, one by one or all at once with "Undo". Unread changes without a task are counted as "N new" until the page is opened. Members do not see any of it. Each release's changes are a data file (`priv/whats_new/<version>.exs`), read and checked at compile time: literals only, at most five entries, unique ids, known areas and permission sets, a task needs a link, a hint needs a task. This PR ships the files for 1.5.0 and 1.6.0 and the rule for writing them (`docs/whats-new.md`, a step in `docs/releasing.md`). ## What has been changed? - Read the changes of each release from checked data files - Keep each user's what's new state, starting existing accounts on 1.4.0 - Add the what's new page and a sidebar entry counting open and new changes - Keep jump targets clear of the sticky top bar - Mark all open what's new tasks as done at once, with undo - Focus and briefly outline the section a link jumps to - Show an open what's new task as a hint at the place it is about - Describe the dot on the join requests entry to screen readers - Add the rules for what's new entries, hints, sidebar markers and jump targets - Note what's new and that existing accounts start at 1.4.0 in the changelog - Show the admission and rejection emails side by side in the settings - Build the icon markers from daisyUI indicator, badge and status - Add a view dialog that only shows content, closed with Close - Open the email preview in a dialog next to Save and line up both cards - Explain the emails to applicants in a note below them instead of a callout - Make Save the primary action of each email paragraph form ## Definition of Done ### Code Quality - [x] No new technical depths - [x] Linting passed - [x] Documentation is added were needed ### Accessibility - [x] New elements are properly defined with html-tags - [x] Colour contrast follows WCAG criteria - [x] Aria labels are added when needed - [x] Everything is accessible by keyboard - [x] Tab-Order is comprehensible - [x] All interactive elements have a visible focus ### Testing - [x] Tests for new code are written - [x] All tests pass - [ ] axe-core dev tools show no critical or major issues ## Additional Notes - **State per user** (`users.whats_new_since`, `whats_new_seen_version`, `whats_new_done`): the migration starts existing accounts at 1.4.0, so 1.5.0 and 1.6.0 show as new once; new accounts start at the running version. Only a release build shows anything as new or open; a development build and a downgrade show nothing. - **No free input:** the four user actions take no version and accept only ids of tasks the user sees. Who sees an entry depends on the pages a role may open, which the web layer knows, so the domain asks it through the `Mv.WhatsNew.Visibility` behaviour (configured like `:join_notifier`). Done and Undo compute the list from the stored row, locked in the action's transaction, so two tabs or devices keep each other's done tasks. Forged ids, another person's state and members are refused (tests send them). - **Hint at the place:** an on_mount hook (`MvWeb.WhatsNewHint`) keeps the hint for the current path and handles its "Done" on every page; a page shows it with `<.whats_new_hint>` where the task's link lands. A data test fails for a hint no page shows. `<.callout>` gained `title` and `actions` for it (showcase variant added). - **Jump targets:** `scroll-padding-top` on `html` never saw the top bar height (the variable was declared on a descendant), so every `#section` link put the heading under the sticky bar; fixed on its own commit. Every jump now focuses the section's heading and outlines it for about 3 s (no fade with reduced motion). There is no browser test layer; this was checked in Chromium and Firefox, desktop and phone. - **Settings, emails to applicants:** the two emails sit side by side as equal cards; the preview opens in a new view dialog (`<.modal kind={:view}>`: only Close, backdrop closes, wide enough for a 600 px email); a note below both cards replaces the info callout. - **Sidebar:** the join requests dot is now described to screen readers ("Unprocessed requests"); counts and dots follow one rule and are built from daisyUI `indicator`, `badge` and `status` (DESIGN_GUIDELINES §21.2); the hand-positioned `.nav-count` is gone. The CHANGELOG has an upgrade note: existing accounts start at 1.4.0 and see 1.5.0 and 1.6.0 as new; admins and the board have one open task each. Proposed news entry: none for this feature. The newest data file in this PR already holds five entries (the limit), all about changes that ask something of a role; "What's new" introduces itself through its sidebar count on the first sign-in after the update.
fix(settings): make Save the primary action of each email paragraph form
All checks were successful
continuous-integration/drone/push Build is passing
continuous-integration/drone/pr Build is passing
276e8a10f6
simon merged commit a6524e81b2 into main 2026-11-19 00:13:43 +01:00
simon deleted branch issue/mitgliederverwaltung-683 2026-11-19 00:13:44 +01:00
Sign in to join this conversation.
No description provided.