Skip to content

Wiki

Your team's own pages about the workspace: what a system is for, who owns it, how to run it, with live assets, costs and findings.

Each workspace has a wiki for what the data can't say: what a system is for, who owns it, how to run it and what happened in the last incident. Pages are Markdown, link to anything in the workspace, and embed live asset lists, costs, findings and changes, drawn as whoever reads them. It's included in the Team and Enterprise plans.

Beta

Wiki is in beta.

Pages

The Wiki page shows the workspace's pages as a tree, up to 5 levels deep, with what changed recently and the pages that need a look. Each page has:

  • A title and its place in the tree, with the pages under it and the pages that link to it.
  • An audience: everyone in the workspace or workspace admins only.
  • Editors: workspace viewers an admin names, who may save it besides the workspace's admins.
  • An owner, the person who answers for the page.
  • Up to 10 labels, such as runbook or postmortem, to filter the tree by.

A new page can start blank or from a template: system, runbook, postmortem, decision and onboarding. A template's embeds are already in place, and on a page about an asset, group or source they show that thing's own assets and cost. A workspace holds up to 2,000 pages.

Writing a page

The editor shows the Markdown beside its preview, with a toolbar for headings, lists, checklists, links and embeds. Pages take tables, task lists and strikethrough. HTML shows as text, and images are never loaded: an image shows as its description and address.

  • Links into the app. Paste the address of anything in AssetHermit (an asset, a group, an asset or cost source, a rule, a budget, a cost center, an anomaly, a monitor, a health event, a log set, another page or an inventory search), or find it from the link dialog. It shows as a link with its kind's icon. A link to an asset that's gone, or that the reader can't see, is struck through.
  • Other links open in a new tab.
  • Drafts. What you haven't saved is kept in your browser, and others see who has the editor open. If someone saved while you were editing, you see the difference and choose to take theirs or save yours over it.

A page with a link and an embed:

## What runs it

Orders go through [the payments databases](/inventory?q=%24type%3Adatabase.*%20%24tag%3Ateam%3Dpayments).

```embed assets
{"query":"$type:database.* $tag:team=payments","limit":20}
```

Embeds

An embed is a block of live data in a page, added from the editor's toolbar, which writes it for you. Each embed is drawn by the same view the app shows it on, as the person reading: someone who sees only some accounts reads the whole page, but each embed shows them only what their access holds, and one their access doesn't reach says why. No embed reads anything your clouds bill for.

EmbedShows
Assets tableThe first assets a query finds
Asset countHow many assets a query finds
Asset cardOne asset's type, account, tags and cost
Cost chartCost by day or month split by a dimension, what changed, a daily heatmap or a breakdown
Cost totalThe cost of a range, beside the one before
FindingsOpen findings by severity, or one rule's assets
ChangesThe newest changes in the change feed

Asset lists and counts take any query. Cost embeds take a cost report's filters and a range (the last 7, 30 or 90 days, the last 3 or 12 months, this month or last month, or dates of your own), which ends at the last day your cost sources have cost for. A page holds up to 30 embeds; one whose settings don't read shows as an error with its text, and the page still saves.

History and the Trash

  • Every save is a revision. Each page keeps its last 50; its History compares any of them with the page now and restores it as the newest.
  • A page holds up to 256 KB of text.
  • A deleted page goes to the Trash, and the pages under it move up a level. Workspace admins can restore it for 30 days, after which it's removed with its history.
  • Creating, saving, moving, deleting and restoring a page are in the audit log, without the page's text.

Pages that need a look

Every hour, AssetHermit checks each page for signs it's out of date, from what it links to and embeds:

  • Links to things that no longer exist.
  • Queries that found assets when it was saved find none now.
  • Embeds that can't be drawn.
  • Not changed or reviewed in 180 days.

A page that looks stale says why at its top, and the Wiki page lists it under Needs a look. Mark reviewed clears the age without changing the text.

Pages about an asset, group or rule

A page can be about one asset, asset group, asset source, native type or rule, and each of those has at most one page about it.

  • An asset's page and a rule's page have a Wiki card: the page about it, or Write a page for workspace admins, and the pages that mention it.
  • Each group on the Groups page has Wiki page in its menu, which opens its page or starts one.
  • The header search finds pages by title, summary and labels.

Who can write

RoleIn the wiki
Workspace adminCreate pages, move them in the tree, choose who sees each one, its editors, its owner and what it's about, and restore pages from the Trash. Everything an editor can.
A page's editorsSave its text, set its labels, mark it reviewed and delete it.
Workspace viewerRead every page whose audience includes them.
StakeholderNothing in the wiki.

The organization's owner and admins are admins of every workspace. Without a plan that includes the wiki, pages stay readable and nothing changes. See team and sign-in for roles.

Not yet

The assistant doesn't read or draft pages yet, nobody is notified about pages, search finds titles and summaries but not the full text, and pages can't hold images or be imported or exported.