Show what changed after an update #683

Closed
opened 2026-11-13 17:24:18 +01:00 by simon · 0 comments
Owner

Description

After an update, the people who run the club in Mila (board, treasurer, admins) only learn what changed if someone reads the release notes on the code forge. Those are written for the people who operate the instance. A change that affects the club's daily work goes unnoticed: from 1.6.0 on, admission and rejection mails are sent by default, also in existing clubs (#668), and the board should check the texts before the next approval.

Proposal

Content

  • Each release that has something to tell ships a small data file in priv/ with 0–5 entries. Each entry has: a title, one sentence, the area it concerns (members, fees, join requests, settings …), whether it needs an action, and an optional link to the place in Mila or to the docs. Texts go through gettext. The data file is read at compile time; no database table for content.
  • Rule for authors: only changes that alter how staff work or that need an action. Patch releases usually have no entries. Every item names what to do or where to look.

Who sees it

  • Every signed-in user whose role is not plain member (the self-service frame of #665 shows nothing).
  • Each entry is shown only to users with access to its area (e.g. a settings item only to admins).

When and how

  • The user stores the last release version they have seen (Mv.BuildInfo provides the running version). Development builds between releases show nothing new.
  • After the first sign-in on a newer release, entries that need an action appear once as a dismissible notice on the start page. Entries from skipped releases are combined; with more than 5, the notice shows the action items and links to the rest.
  • "What's new" in the user menu opens all entries of the last releases (e.g. the last 5), newest first. The menu entry carries a "new" marker until it is opened or the notice is dismissed.
  • Nothing blocks the page or interrupts a form.

Out of scope
Club-specific announcements by the board, images, read statistics, a per-club switch (later, communication milestone).

Decisions for the design

  • Form of the notice: banner on the start page, callout in the content, or a drawer (GitLab opens its "What's new" in a drawer from the help menu).
  • Whether an action item stays visible until dismissed or disappears after the first visit.
  • Wording and place of the menu entry, and how the "new" marker is announced to screen readers.

Acceptance criteria

  • A user with a staff role who signs in for the first time after an update sees the action entries of all releases since their last visit once, filtered by their permissions; after dismissing, the notice does not return.
  • A plain member never sees the notice or the menu entry.
  • "What's new" in the user menu lists the entries of the last releases the user may see; the "new" marker disappears after opening.
  • A release without entries and a development build show no notice. A new account gets the running version stored and sees no notice; the menu still lists the entries. Existing users are migrated to the previous release (1.5.0), so the 1.6.0 entries reach them.
  • Texts are translated; the notice and the menu marker are keyboard- and screen-reader-accessible and meet AA contrast in both themes.
  • The 1.6.0 data file contains at least the entry about admission and rejection mails (#668).

Dependencies

  • After #665 (start page, user menu and member frame).
## Description After an update, the people who run the club in Mila (board, treasurer, admins) only learn what changed if someone reads the release notes on the code forge. Those are written for the people who operate the instance. A change that affects the club's daily work goes unnoticed: from 1.6.0 on, admission and rejection mails are sent by default, also in existing clubs (#668), and the board should check the texts before the next approval. ## Proposal **Content** - Each release that has something to tell ships a small data file in `priv/` with 0–5 entries. Each entry has: a title, one sentence, the area it concerns (members, fees, join requests, settings …), whether it needs an action, and an optional link to the place in Mila or to the docs. Texts go through gettext. The data file is read at compile time; no database table for content. - Rule for authors: only changes that alter how staff work or that need an action. Patch releases usually have no entries. Every item names what to do or where to look. **Who sees it** - Every signed-in user whose role is not plain member (the self-service frame of #665 shows nothing). - Each entry is shown only to users with access to its area (e.g. a settings item only to admins). **When and how** - The user stores the last release version they have seen (`Mv.BuildInfo` provides the running version). Development builds between releases show nothing new. - After the first sign-in on a newer release, entries that need an action appear once as a dismissible notice on the start page. Entries from skipped releases are combined; with more than 5, the notice shows the action items and links to the rest. - "What's new" in the user menu opens all entries of the last releases (e.g. the last 5), newest first. The menu entry carries a "new" marker until it is opened or the notice is dismissed. - Nothing blocks the page or interrupts a form. **Out of scope** Club-specific announcements by the board, images, read statistics, a per-club switch (later, communication milestone). ## Decisions for the design - Form of the notice: banner on the start page, callout in the content, or a drawer (GitLab opens its "What's new" in a drawer from the help menu). - Whether an action item stays visible until dismissed or disappears after the first visit. - Wording and place of the menu entry, and how the "new" marker is announced to screen readers. ## Acceptance criteria - [ ] A user with a staff role who signs in for the first time after an update sees the action entries of all releases since their last visit once, filtered by their permissions; after dismissing, the notice does not return. - [ ] A plain member never sees the notice or the menu entry. - [ ] "What's new" in the user menu lists the entries of the last releases the user may see; the "new" marker disappears after opening. - [ ] A release without entries and a development build show no notice. A new account gets the running version stored and sees no notice; the menu still lists the entries. Existing users are migrated to the previous release (1.5.0), so the 1.6.0 entries reach them. - [ ] Texts are translated; the notice and the menu marker are keyboard- and screen-reader-accessible and meet AA contrast in both themes. - [ ] The 1.6.0 data file contains at least the entry about admission and rejection mails (#668). ## Dependencies - After #665 (start page, user menu and member frame).
simon closed this issue 2026-11-19 00:13:44 +01:00
Sign in to join this conversation.
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set

Reference
local-it/mitgliederverwaltung#683
No description provided.