Workstreams Planning
Workstreams > Planning lets you click down through a plan: from every workstream, to a workstream's tracks, to a track's phases, to a phase's deliverable rows. At each level you can see what is left and who did what. It is an experimental prototype. It is read-only: it reads the workstream files on this machine and writes nothing. It is local: it shows a plan only on a machine where a planning snapshot has been built (see Build the snapshot).
Who sees it
Planning is an item of the Workstreams menu, after Setup (or Settings) and Team. It shows
only for people who hold both the Workspace.Experimental right and the Workspace.Experimental.UX
right:
- With both rights, the Workstreams menu holds Setup or Settings, Team and Planning.
- With only
Workspace.Experimental, the menu holds Setup or Settings and Team, and no Planning. - With only
Workspace.Experimental.UX, there is no Workstreams menu at all. The UX right adds to the Experimental right; it never stands in for it.
Nobody holds Workspace.Experimental.UX by standing. See Permissions.
Build the snapshot
The window does not read your plan files one by one. A script reads them once and writes one planning snapshot, a single file on this machine:
- In the
openx-experience-workbenchproject, rundeno task planning:index. - It writes
C:/fathym/planning/workstreams-planning.json. Nothing is committed and nothing leaves the machine. - The local workspace runtime reads that folder, read-only. After the first build, refresh the local workspace runtime so it sees the folder.
Run the task again whenever you want the window to show newer plans. The snapshot says when it was written.
What the window shows
At the top is a strip marked Experimental UX that says it is a prototype, read-only, from this machine's workstream files, and that nothing is written. Under it, in this order:
- What was not read, first. Every source the snapshot could not read is named, with what to do about it, and the strip says how fresh the CI results are. A source that was not read is never drawn as an empty list.
- The counts for the level you are on: rows ticked, open, held, partial, and rows with no box.
- Where you are: all workstreams, then the workstream, track and phase. Press any of them to go back up.
- Three tabs:
- Plan: a card for each workstream, track or phase, with an Open button to click down. At a phase, a card for each deliverable row, with its file and line and its box. Press a row to see the commits that landed it, the CI result at each one, its cards, its proof lines and its test plan rows.
- What is left: at a phase, the open, held and partial rows with what each row says. Above a phase, how many rows are open, held and partial under each card. Held rows are counted apart from open rows.
- Who did what: the Session Log rows and commit notes for the level, newest first. "Who" is the card or seat written in the note, because every commit has the same git author.
The words say what was seen, never a verdict: a row is ticked, or ticked, no landing sha, and a commit shows CI green at the landing sha. A tick is what the file says; the window does not call a row proven.
It writes nothing
The window only reads. It never ticks a box, edits a plan, makes a proposal or keeps anything in your browser. To change a plan, edit the workstream files, then build the snapshot again.
When something is missing
The window says what is missing and what to do. Each source the snapshot could not read is listed as "Not read: the source (its kind)" with the remedy:
| Kind | What it means | What to do |
|---|---|---|
| NOT_PERSISTED | The source keeps no record of its own (mutant runs, for example). | Read the report the row names; the window shows the cell as written. |
| ABSENT | The source is not there (a workstream with no test plans folder). | Add it where the remedy says, then build the snapshot again. |
| UNREADABLE | The source is there but could not be read. | Fix the file the remedy names, then build the snapshot again. |
The window itself can also say:
- No planning snapshot on this machine. There is no snapshot file. Run
deno task planning:index, then open the window again. - The planning snapshot on this machine could not be read. The file is broken. Run
deno task planning:indexagain. - This level is not in the planning snapshot. The level you asked for is gone from the newest snapshot. Press All workstreams to start again.
Related
- Workstreams Setup - the Workstreams menu, its setup and Team windows.
- Permissions - where access rights come from.
On fathym.com: OpenX →