An override changes what the public documentation site shows for one article. It exists for text that is live and wrong right now.
Only on the operator's install
An override is visible only on the documentation site, which is served from the operator's own host. On any other install this page shows a note saying so instead of an editor: the in-admin drawer reads the guides shipped in the release, so there is nothing to edit.
The list
Filter by text, plugin, language and state: all, overridden, or stale. Each row shows the title, the plugin and a state badge:
- Published: the article is as shipped.
- Overridden: your text is showing.
- Stale: your text is showing, but the published article has changed since you wrote it.
Row actions: Edit and, for an overridden article, Reset. Re-sync corpus at the top rewrites the database copy from the shipped guides; it leaves overrides alone and is rarely needed.
Editing
Edit opens the article's title, summary and body (a rich-text editor). Show published text reveals what shipped, so you can compare. A warning appears when the override is stale.
A field you leave identical to the published text is saved as "not overridden" and keeps following later releases. Only the fields you really change are frozen. The body is cleaned of unsafe markup when saved.
Resetting
Reset deletes the override after a confirmation and returns the article to the shipped text.
Rules of thumb
- Use it for an emergency correction only; put the real wording change in the guide file in the repository.
- An override that outlives its emergency silently hides every later correction to the same article.
- Images do not belong here. An override is a patch in one install's database; it vanishes when someone presses Reset. Screenshots go in the repository.
- Needs Manage (
kb.manage).