A changelog entry is written in the same editor as an article, but it carries release metadata instead of category, tag and slug settings. Each entry has a title, an optional version and a release date, and the public feed orders entries by that date, newest first.
Write an entry
- Open your changelog knowledge base and go to its Changelog page.
- Click New Entry.
- Type the title on the first line of the editor. The placeholder asks "What's the main feature?"; a short headline such as "Instant search" works best.
- Optionally enter a Version in the field pinned to the right of the title, up to 30 characters, for example
v1.2.0or2024.01. - Set the Release date in the top bar. It defaults to today, and you can back-date or post-date it.
- Write the release notes in the body, using the same slash menu, formatting and image uploads as an article; see Using the editor: slash menu, bubble menu & block handles.
The entry autosaves as you write, and a save indicator in the top bar shows its state.
What is different from an article
| Article | Changelog entry | |
|---|---|---|
| Title | Separate title field | The locked first line of the editor, sharing one undo history with the body |
| Version | None | Optional free-text version, up to 30 characters |
| Release date | None | Required date; drives the order of the public feed |
| Categories and tags | Yes | None; the feed is a single list |
| Excerpt and slug settings | Yes | None |
| Editor and images | Same | Same |
Publish, edit and retire an entry
The lifecycle mirrors articles:
- Publish a draft from the status menu in the top bar (Draft, Published, Archived).
- Editing a published entry creates an Unpublished changes draft on top of the live version. Readers keep seeing the live entry until you choose Publish or Discard changes; see Edit a published article safely (the "Unpublished changes" draft).
- Archive removes the entry from the public feed while keeping it; Trash starts the 30-day purge clock and restoring returns the entry as a draft; see Trash: delete, restore & the 30-day purge.
Use View public page in the editor's top bar to open the live entry. Back on the Changelog page, the search box finds entries by title or version.