Repository navigation
Add content API runbook - #446
Merged
Merged
Conversation
Adds a runbook for the content API and links it from the System in manifest.yml. For wellcomecollection/platform#6792, part of wellcomecollection/platform#6790.
Contributor
There was a problem hiding this comment.
🟡 Changes recommended
The runbook’s inaccurate guidance on unpublishing, deletion recovery, and snapshot recency could misdirect incident diagnosis and content restoration.
3 open issues
What changed in this PR
Adds an operational runbook for the Content API and its supporting services, with a Backplane link so responders can find it. This is documentation and catalogue metadata only; runtime behaviour and deployment configuration are unchanged.
Changes:
- Documents service architecture, alerts, troubleshooting, recovery and rollback procedures.
- Links to dependency status pages and incident escalation guidance.
- Adds a Runbook link to the content-api System metadata.
| File | Description |
|---|---|
manifest.yml |
Adds the System’s Backplane Runbook link. |
docs/runbook.md |
Adds operational guidance for the API, pipeline, webhook, unpublisher and Prismic backups. |
Review effort: Balanced
rcantin-w
reviewed
Nov 16, 2026
rcantin-w
left a comment
Contributor
There was a problem hiding this comment.
Claude suggested a change to the Readme that was contradicting the runbook, also suggesting we add a link to said runbook.
## Developing
- Deployment is all done in CI, see `.buildkite/pipeline.yml` — except the Prismic backup Lambdas and the Terraform in `infrastructure/`, which are deployed from a laptop
- `husky` will set up a pre-commit hook for autoformatting when you first install dependencies
- [Runbook](docs/runbook.md): alarms, common failures, rollback
Co-authored-by: Raphaelle Cantin <110461050+rcantin-w@users.noreply.github.com>
Also say which parts of the README deploy outside CI and link the runbook.
Contributor
Author
|
Thanks, applied in 3acfe90: the README now says which parts deploy from a laptop and links the runbook. |
rcantin-w
approved these changes
Nov 16, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.

What does this change?
Adds
docs/runbook.mdfor the content API (API, pipeline, webhook, unpublisher and Prismic backups) and a Runbook link on the content-api System inmanifest.yml.How to test
Read the runbook on the branch. The Runbook link shows on the Backplane entity page once merged.
Have we considered potential risks?
Docs and catalogue metadata only, no code or deploy changes.