Topline Docs

Knowledge Bases

Knowledge Base releases and publishing

Validate, review, publish, pause, and restore a knowledge base release.

Knowledge Base releases and publishing

Validate, review, publish, pause, and restore a knowledge base release.

Where to find it

Choose Knowledge Bases in the main navigation, open the collection, and select Overview.

Address: /knowledge-bases/:id. Open the saved resource from the product rather than typing this address.

Review live and draft state

Open Overview. The release summary distinguishes the current live version, draft changes, and a candidate awaiting review. Connected apps keep using the last published version while changes remain in draft.

Publish a release

  1. Add or correct draft content and connection policies.
  2. Choose Validate draft, or Retry validation for a failed candidate.
  3. Complete the required retrieval tests in Quality.
  4. Choose Review & publish.
  5. Review the exact version, content, audience, and connection summary.
  6. Choose Publish version N and confirm the resulting live release.

Publication replaces the release used by the HTML endpoint and approved tool connections. Draft content, audience changes, and document policies do not reach live readers before publication.

Pause, resume, and archive

In Overview > Availability, Pause stops delivery and invalidates current grants without deleting the content. Resume requires a current published release with ready source dependencies and rotates active grants. Previously issued access can stop working; recheck connected consumers after resuming.

Archive stops delivery, hides the base from the active library, and preserves its content. It also cancels queued/running import jobs and their scheduled refreshes. Restoring an archived base with a published release returns it as paused; a base without a published release returns to draft. Check content, sources, quality, and connections before resuming or publishing. Do not assume old imports automatically restart.

Roll back a release

Review the intended saved release before using its rollback action. Check that its source dependencies and access policies are still appropriate, then verify the live version and connected consumers. A rollback is not permission to reconnect a revoked consumer or bypass a disconnected source.

Recovery

Publishing stays disabled until candidate validation and required tests pass. If an action fails, refresh the release state before retrying so you do not act on an uncertain version.