Quickstart: open the dashboard and record the first risk
The shortest way from “the plugin is installed” to “the project's figures are on one screen, and the risk register holds its first entry”. Two steps, about five minutes.
Prerequisites
wkdodashboard,wkdocore,wkdostorageandwkcoreare installed and enabled.- A project with work items in it; ideally a registered repository too, so the health panel has something to report.
- For the second step, a role that permits editing.
There is nothing to set up. The dashboard keeps no counters of its own — it therefore cannot disagree with the data it summarises.
Step 1: open the dashboard
Open the project's Dashboard hub:
/doku.php?id=en:projects:acme:dashboard&do=wkdodashboard
Step 2: record a risk
Under Risks choose Add risk and enter one — with a severity (Low, Medium, High, Critical) and a status (Open, Mitigating, Accepted, Closed).
The register lives with the project, alongside everything else about it — rather than in a spreadsheet somebody has to remember to open.
Check the result
- The Work items card counts the project's items by state: New, Active, Resolved, Closed. The total agrees with what the Queries hub returns unfiltered — both read the same items.
- The Blocked card stands as its own figure and not as one line in the state breakdown. That is deliberate: it is the number somebody acts on. Folded into a general breakdown, the reader would have to extract it.
- The Repositories card reports, for each registered repository, whether it is usable: OK, Unreachable, Invalid, Denied or Unknown. That sits here and not only in the repository views so that “something is wrong with a repository” is visible from the project's front page rather than requiring somebody to go and look — which, in practice, nobody does until something else has already failed.
- Your risk is in the list.
Risks carry three permissions, not one: viewing, editing and removing. Removing is separate from editing because editing changes a record while removing ends its history — and part of a register's purpose is being able to show that a risk was considered.
Next step
- wkdoworkitems — the items the figures come from.
- wkdogit and wkdoadogit — the repositories whose health is reported here.
- wkdodashboard (German) — the package page: the read model and the three permissions.
en/wiki/dwe/wkdodashboard/quickstart.txt · Last modified: by 0.0.0.0