Skip to content

Changelog ​

The Changelog page is the operator-facing view of the same content customers see in their Customer Portal under What's New. It is a chronological, public-facing record of completed releases and their notes.

Layout ​

  • Header with title and description.
  • Filter toolbar — search, type filter, month filter, Clear.
  • A row of month links ("Jump to") above the cards.
  • Cards grouped by month, newest first.
  • Load More at the bottom.

Filters ​

FilterBehaviour
SearchSubstring match on version number.
TypeFeature / Hotfix / Config, multi-select.
MonthReverse-chronological list of months that have releases.
ClearResets everything.
Count"5 of 47" — filtered entries vs. total.

Changelog card ​

Each card represents one completed release:

  • Release name or version (monospace, bold).
  • Type badge (Feature / Hotfix / Config).
  • Completion date.
  • Release notes rendered as rich HTML (headings, bold, lists, images).
  • View release → link to the release detail page.

What appears here ​

  • Only releases in the completed status.
  • Only releases that have release notes. Config releases that were submitted without notes do not appear, even if they completed successfully.

Pagination ​

Releases load in pages of 5. Click Load More to fetch the next page. Loaded pages stay in memory — switching filters re-applies them to what is loaded.

Tips for writing release notes ​

The notes here are what your customers see, so write them for customers, not for engineers.

  • Lead with the user-visible change, not the implementation.
  • Group by area (Tenants, Billing, Migrations …) when a release touches several.
  • Show screenshots of the new UI when it helps.
  • For hotfixes, say what was broken in plain language.
  • Don't dump JIRA tickets.

The rich-text editor on the New Release page supports images — paste them inline rather than linking to an external URL.