docs: Assessment 3 README, deployment runbook, video script and checklist - #7
Merged
Merged
Conversation
…list README now describes the system as it is: the observability architecture, the dashboard, the two new models and why FeedFetch is separate from RequestLog, the tracing and metrics sections, and the testing results with links to the full analysis. docs/deployment.md is the EC2 runbook, including the failure this codebase is most likely to hit — client-side code that resolves only on localhost works perfectly over SSH and fails completely for anyone else, so the verification step insists on a browser on a different machine. docs/submission.md lists what has to be handed in, and the questions to have an answer ready for in the live defence. VIDEO_SCRIPT.md is timed for seven minutes, and puts two minutes on the dashboard because that is the largest single mark. Its most important beat is curling a feed on camera and watching the counters move: a dashboard that changes while you watch proves the figures are live in a way no amount of narration does. Also fixes something the docs revealed. All three documents told the reader to prove persistence with `sqlite3` inside the container — and sqlite3 was not in the image. That command is the one Tony asks for in the oral defence, so it is now installed in the runner stage rather than quietly removed from the instructions. Verified: it returns the same per-feed counts the dashboard displays. Full stack verified from a clean `docker compose down -v` and rebuild: all four services up, container healthcheck healthy, dashboard totals matching generated traffic, custom spans in Jaeger, all three Prometheus targets up, valid RSS, 404 on an unknown channel, and the rows visible in SQLite. Co-Authored-By: Claude <noreply@anthropic.com>
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
1 participant
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.
Documentation for everything built in #2–#6, plus one real fix the writing exposed.
FeedFetchvsRequestLog, tracing/metrics sections, testing resultsThe fix: all three documents told the reader to prove persistence with
sqlite3inside the container — andsqlite3wasn't in the image. That's the exact command asked for in the oral defence, so it's now installed in the runner stage rather than dropped from the instructions.Verified from a clean
docker compose down -v+ rebuild: four services up · healthcheck healthy · dashboard totals match generated traffic · custom spans in Jaeger · 3/3 Prometheus targets up · valid RSS · 404 on unknown channel · rows visible in SQLite.🤖 Generated with Claude Code