Everything below is the shape a Depot release note takes. The seven headings
and their anchors are fixed, so that a link to #security or #upgrade-notes
keeps working across every release.
Highlights
Section titled “Highlights”- The change most people will notice. One sentence on what it does for the reader, then a link to the page that explains it. See operating modes.
- The second one. Same shape. Two or three of these, no more.
- What is now possible that was not possible before, written from the reader’s side rather than the implementation’s.
Changed
Section titled “Changed”- What used to happen, and what happens now. The old behaviour is named because that is what the reader remembers.
- The symptom that no longer happens, described the way somebody hitting it would have described it.
Security
Section titled “Security”- Severity. What was wrong, what an attacker would need, and what they could do. If a deployment is exposed without the fix, the note says so here rather than in the highlights.
Known issues
Section titled “Known issues”- KI-0000. The symptom and the workaround, with the identifier so that a support conversation can name it. See known issues.
Upgrade notes
Section titled “Upgrade notes”No action is needed beyond installing this version.
This heading is never deleted. A reader looking for it and not finding it assumes the note is incomplete, so a release with nothing to do says so.
Content is licensed CC BY 4.0. Code samples are MIT. Outpost and the Outpost mark are trademarks of Outpost Business Solutions, PBC and are not covered by either licence.