Skip to content

Update the admin and CMS user guides (#823) - #834

Merged
ajs-uk-dev merged 6 commits into
mainfrom
823-update-user-guides
Nov 11, 2026
Merged

ajs-uk-dev merged 6 commits into
mainfrom
823-update-user-guides

Conversation

@ajs-uk-dev

@ajs-uk-dev ajs-uk-dev commented Nov 11, 2026 •

Copy link
Copy Markdown
Contributor

Closes #823

What this does

Brings both user guides level with the service on main. Documentation only: no product code, view, seed, rule or test changes.

Admin user guide (docs/user-guides/admin-user-guide.md and the PDF)

  • Chapter 7 is rewritten as "Manage windows" for the exercise, data file and release model: the four window types and what each starts with, the Manage windows list and its tags, the create pages, the window summary, editing an exercise (Exercise Details, Dates, Data), adding a data file, validating and data releases, retiring a file and putting it back in use, the December files for Key Stage 2, the Key Stage 4 Autumn pupil schema, and deleting a window or an exercise.
  • New chapter 10, "View as an establishment". Danger zone is now chapter 11.
  • Chapters 1 to 6, 8, 9 and 11 and the appendices are corrected: the DfE header, the entries on the Administration page, the Messages badge, UK-time publishing, banners on the guidance front page, the rule editor's fields and operators, data egress reading its values from the Zendesk ticket, audit log rows for extensions and impersonation, two storage accounts, and what Reset seed data restores.
  • Version line: 1.1, 11 November 2026. The PDF is rebuilt (100 pages).

How to use the CMS (docs/user-guides/cms/pages, cms-guide.json)

  • Publish from and Publish to are UK time (the pages said UTC).
  • Home page banners also show on the guidance front page; banners added to the role and audit pages.
  • A new section on the evidence guidance content blocks; the home block key is home-content_v2.
  • Search: what is searched (not Summary lists), the page filter, and opening a result at the matching section.
  • The bundle is rebuilt, so every environment takes the new pages at start-up.

Screenshots

Every screenshot in both guides is recaptured from the local stack with the DfE header, and there are four new ones for the window screens. The admin capture.mjs gains clicks, hide, clipWidth and clipHeight options (documented at the top of the file).

How it was checked

  • Each changed statement was checked against the views and classes, then reviewed once more against the code by a second pass; its corrections are in.
  • Walked in a browser on the local stack, on a window made for the purpose and deleted afterwards: create a window, add a data file, choose a CSV, upload a schema, validate twice, make the earlier release live, retire and put back in use, delete the exercise and the window. Also the requests table, storage browser, egress pages, audit log, the Versions tab, the in-app guide and a banner on /guidance.
  • npm run build passes for both guides (links, screenshots, alt text).

Not checked

  • "View as an establishment" was written from the code only. The local stack cannot sign in with the real cypmd_admin role, so the chapter has no screenshots and nobody has compared it with the running screens. A reviewer with the role in a deployed environment is asked to read chapter 10 against the screens.
  • Extensions, closing an exercise early and sending requests for processing were checked against the code, not exercised in the browser.
  • ShippedContentImportTests was not run locally; CI runs it.

For reviewers

  • The screenshots show sample data from a development stack (the guide now says so), including a large number on the Messages badge.
  • The guide describes two Cancel links on the create pages as they behave today.

Andy Smith and others added 6 commits November 11, 2026 10:38
…ch and segment rules (#823)

Co-Authored-By: Claude Fable 5.2 <noreply@anthropic.com>
…iles and releases (#823)

Co-Authored-By: Claude Fable 5.2 <noreply@anthropic.com>
…m tickets, audit rows, two storage accounts (#823)

Co-Authored-By: Claude Fable 5.2 <noreply@anthropic.com>
…the PDF and the CMS guide bundle (#823)

Co-Authored-By: Claude Fable 5.2 <noreply@anthropic.com>
…eenshot captions (#823)

Co-Authored-By: Claude Fable 5.2 <noreply@anthropic.com>
Co-Authored-By: Claude Fable 5.2 <noreply@anthropic.com>
@github-actions

github-actions Bot commented Nov 11, 2026 •

Copy link
Copy Markdown

Review app for PR 834 was deleted

@github-actions

github-actions Bot commented Nov 11, 2026 •

Copy link
Copy Markdown

E2E tests passed

397 passed, 0 failed, 4 skipped in 21 min 39 s

Commit 6c4d829 against https://check-performance-data-pr-834.test.teacherservices.cloud (run)

@ajs-uk-dev
ajs-uk-dev merged commit 6582b5f into main Nov 11, 2026
19 checks passed

This branch was previously deployed

1 inactive deployment
review — 6c4d8295 Deployed Nov 11, 2026 by ajs-uk-dev via Delete Review App 834 #432
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Update user guide

2 participants