mix
0730b2090e
[1.3.0] Security and quality after 1.2.5: domain-admin send-log authorization, fail-closed sign-in and application delete, level-2 rate-limit race fix, restore Resync, expanded tests, operator docs, release CI, and OFL for IBM Plex. Upgrading from 1.2.x is a tag bump; no migration. Added: - licence: the SIL Open Font License 1.1 text now travels with the IBM Plex - docs: agreed roadmap item **queue-retries** — show this Postfix's retry Security: - The independent security review of the send-log authorization and Fixed: - test (e2e): send-log status scrapers follow the badge markup in - security (panel): the Deliveries list is scoped to a domain administrator's - mail (level-2 rate limit): the ceiling is no longer overshot by messages that - panel (sign-in): a session that cannot be written to the database no longer - panel (applications): deleting an application removes its SASL credentials … (2 more in CHANGELOG) Changed: - docs: operator and as-built docs aligned with the code after a full - docs: [guide.md](docs/guide.md) reorganised into **Installation**, **Instance - docs: the 2026-08-13 full-tree review plan is complete — every phase (P0–P7) - licence: [NOTICE](NOTICE) tells modifiers to update `SourceURL` in - ci: the release image is published only for a **published** GitHub Release … (9 more in CHANGELOG) [1.3.1] Retry policy in the panel, persistent Postfix queue, and self-contained full backups. Mail queue and delivery history show this Postfix's first retry, backoff cap, and queue lifetime. Deferred mail survives container recreate. Full backups now archive `data/`, compose, `.env`, and `certs/`; the archive layout breaks 1.3.0 flat backups (unpack those with `tar xzf backup.tar.gz -C ./data` as before). Upgrading from 1.3.0 is a tag bump; no schema migration. Added: - Mail queue and a delivery's history show this Postfix's retry policy - docs: **Plan checklists** in [development.md](docs/development.md) — format, - docs: **Implementation checklists** with model routing in - docs: roadmap candidates **send-log-retention** (panel Settings for delivery - Postfix queue under `/data/postfix/queue` — deferred and active mail survive … (1 more in CHANGELOG) Changed: - **Breaking:** full-backup archive layout — paths are prefixed with `data/`; - docs: operator guide, architecture, security, and backup UI updated for - docs: HTML mockups for a full panel UI refresh Changed: - docs: panel UI mockups after review — Status restored to live readings - docs: panel UI design system and mockups rebuilt as separate pages - docs: panel UI mockups — add-domain sits in the list card (Domains and Fixed: - ci (GHCR): per-arch package tags (`X.Y.Z-amd64`, `X.Y.Z-arm64`) are dropped Squashed CHANGELOG sections: [1.3.0], [1.3.1]. Full detail: CHANGELOG.md (1.3.0, 1.3.1).
55 lines
1.9 KiB
Markdown
55 lines
1.9 KiB
Markdown
# Plan: panel-docs (in-panel operator documentation)
|
|
|
|
**Status:** candidate
|
|
**Date:** 2026-08-17
|
|
**Version:** `1.x` MINOR; `candidate` until explicitly agreed.
|
|
|
|
---
|
|
|
|
## Goal
|
|
|
|
Built-in operator documentation in the panel — short pages or a help drawer that
|
|
explain what each Status check and other controls mean, without sending the
|
|
operator out to [guide.md](../guide.md).
|
|
|
|
## Scope
|
|
|
|
**In:**
|
|
|
|
- Help drawer or short help pages (CSS-checkbox pattern from
|
|
[panel-ui mockups](../assets/panel-ui/system.html)).
|
|
- Seed content: Status blurbs removed from cards for a denser layout — Machine
|
|
(kernel counters / rate window), TLS certificate (port 465, reverse-proxy
|
|
mount), Hostname / reverse DNS (FCrDNS, PTR at the hosting provider), and
|
|
similar notes for other surfaces as inline commentary is removed.
|
|
- «?» entry points on domain cards (mockups).
|
|
|
|
**Out:**
|
|
|
|
- A second copy of the full operator guide.
|
|
- Translation workflow beyond English (same as the rest of the panel).
|
|
|
|
## Done when
|
|
|
|
An operator can open help from the panel for those topics; the removed Status
|
|
blurbs are preserved there (or equivalent); no requirement to read the git
|
|
tree for day-to-day meaning of a card.
|
|
|
|
## Risks
|
|
|
|
Copy ownership and keeping help in sync when checks change; not bloating every
|
|
page with a second column of prose.
|
|
|
|
## Implementation checklist
|
|
|
|
Target version cut: **`1.8.0`** (MINOR). One commit per step; code only after
|
|
roadmap status is **agreed**. See [development.md](../development.md) § Plan
|
|
checklists.
|
|
|
|
- [ ] Help drawer / pages shell (CSS checkbox pattern from mockups) — **Sonnet**
|
|
- [ ] Seed Status blurbs (Machine, TLS, PTR, …) — **Sonnet**
|
|
- [ ] «?» entry points on domain cards — **Sonnet**
|
|
- [ ] [guide.md](../guide.md) boundary: in-panel help vs full guide — **Sonnet**
|
|
- [ ] Template tests — **Sonnet**
|
|
- [ ] `go vet`, `go test` on touched packages — **Haiku**
|