On this page

What approval is for#

Once a spec is agreed and published, people rely on it. A quiet edit can change what a client signed off without anyone noticing. Turn on approval for a category and nobody's edit reaches a published article in it until a publisher has looked at it.

With approval on, editing a published article saves a proposed change instead. The live version stays exactly as it was, for your team and your customers, until a publisher approves the change. Then it goes live in one step and is recorded in the article's history.

Off until you switch it on

Approval is off for every category, new and existing. Until a publisher switches it on for a category, editing a published article saves live, as it always has.

Turning it on for a category#

On Manage articles, open the category's ⋯ menu and choose Edit. Switch on Changes to published articles need approval and click Save. Like every category setting, this needs Publish knowledge-base articles.

The setting covers:

  • Published articles only. Drafts, including client spec drafts, and archived articles edit as usual.
  • Articles filed directly in that category. It is not inherited: its subcategories each have their own switch. Uncategorized articles never need approval.
  • The title and the body. Pinning a review comment to words does not change what the article says, so it needs no approval.

Nobody is told about a proposed change unless they watch the article or the category, so watch the category if you approve its changes. See Watching articles and categories.

Proposing a change#

Open the published article and edit it as usual. A note above the body tells you what is happening:

Changes to this published article need approval. Your edits are saved as a proposed change; the live version is unchanged.

Your edits autosave into your proposed change, not the live article. You can close the editor and come back later: it reopens on your proposed change. If you change everything back to how the live version reads, there is nothing left to approve and the proposed change goes away.

When it is ready, click Submit for approval. Only the person who proposed the change can submit it.

Two more buttons sit beside it:

  • Withdraw submission, once you have submitted, takes the change back so you can keep editing.
  • Discard changes, at any point before it is approved, throws the proposed change away. The live article is untouched.

Restoring an earlier version from History under approval works the same way: the restored title and body become a proposed change rather than going live. See Article history and restore.

One proposed change at a time#

An article has at most one open proposed change. While it is open, nobody else can edit the article:

  • while someone is still writing it, others see Name is editing a proposed change to this article. Your edits cannot be saved until it is sent, approved or discarded.
  • once it is submitted, everyone sees A proposed change to this article is waiting for approval. It cannot be edited until the change is approved or the submission is withdrawn.

Moving the article or changing its visibility#

A published article under approval cannot be moved to another category, or have its visibility changed: Changes to this published article need approval, so it cannot be moved or have its audience changed. Unpublish it first.

Changing the summary#

A proposed change carries only the title and body, so the summary of a published article under approval cannot be changed: the field is greyed out in the editor. To change it, unpublish the article first.

Reviewing a proposed change#

When a change is waiting, holders of Publish knowledge-base articles see Review proposed change on the article. It opens a full-screen comparison, Published now beside Proposed, with who proposed it.

  • Approve makes the proposed version the published one at once. A note is optional.
  • Request changes sends it back to the proposer. A note is required here, up to 2,000 characters; the proposer sees it above the body as Changes requested: followed by your note, edits the proposed change and submits it again.
  • Cancel closes the comparison and changes nothing.

A publisher can approve their own proposed change. Comments pinned to the live article's words while the change was waiting keep their pins when it is approved.

Changes that can no longer be approved#

A proposed change is compared against the version it was started from. If the published article has changed since, approving it would silently undo that change, so DevStride refuses: The published article changed after this proposal was started, so it cannot be approved. Request changes or discard it. The comparison then offers Discard the proposed change. The proposer can also no longer submit it, and is told to discard it and propose the change again.

If the article was unpublished after the change was submitted, it cannot be approved either: request changes, discard it, or publish the article again first. Once an article is a draft again, edits to it save directly.

If someone submits the change again while you have the comparison open, your decision is refused and you are asked to review the current version.

When the client approves too#

If the article is shared with specific companies (its audience), submitting a proposed change also asks those companies to approve it. Their portal contacts see it on the Reviews page of their customer portal, as Proposed change to article, with the proposed version to read. It also appears under Waiting on you on their portal's Home page and, when the article is a spec, under Waiting for your approval on their Specs page.

  • Approve from the client works exactly like a publisher's approval: the proposed version goes live.
  • Request changes sends it back to the proposer with the client's note, as a publisher's would.
  • Whoever decides first, a publisher or the client, settles the change. When the article is shared with several companies, a reviewer at any of them can approve.

A change that can no longer be approved (the published article moved on) shows as out of date on the client's card too. An article shared with every company asks no client: only publishers decide.

Turning approval off#

Switching the category's setting off makes edits to its published articles save live again. A change already waiting for approval can still be reviewed, approved, sent back or discarded.

Who can do what#

Action Who
Switch approval on or off for a category Publish knowledge-base articles
Propose a change Anyone who can edit the article's content (see Knowledge Base permissions)
Submit for approval The person who proposed it
Withdraw submission, Discard changes The person who proposed it, or a holder of Publish knowledge-base articles
Review proposed change: Approve, Request changes Publish knowledge-base articles, or a portal contact of a company the article is shared with, from the portal's Reviews page

What the history shows#

Proposing, submitting and sending back a change add nothing to the article's history, because the article itself has not changed. An approved change is one Approved change entry, credited to the person who proposed it, with the name of the publisher who approved it: for example Sam Lee, approved by Ana Ruiz.

Powered by DevStride