From 49e0953c4a9bd2dd2a84c95c690375e8c511ce63 Mon Sep 17 00:00:00 2001 From: Stuart Axelbrooke Date: Sat, 26 Jul 2025 22:57:27 -0700 Subject: [PATCH] Prepare for job wrapper implementation --- plans/job-wrapper.md | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/plans/job-wrapper.md b/plans/job-wrapper.md index 60e995e..1fb9516 100644 --- a/plans/job-wrapper.md +++ b/plans/job-wrapper.md @@ -1,5 +1,15 @@ # Job Wrapper v2 Plan +## Required Reading + +Before implementing this plan, engineers should thoroughly understand these design documents: + +- **[DESIGN.md](../DESIGN.md)** - Overall DataBuild architecture and job execution model +- **[design/core-build.md](../design/core-build.md)** - Core build semantics and job lifecycle state machines +- **[design/observability.md](../design/observability.md)** - Observability strategy and telemetry requirements +- **[design/build-event-log.md](../design/build-event-log.md)** - Event sourcing model and BEL integration +- **[databuild.proto](../databuild/databuild.proto)** - System interfaces and data structures + ## Overview The job wrapper is a critical component that mediates between DataBuild graphs and job executables, providing observability, error handling, and state management. This plan describes the next generation job wrapper implementation in Rust. @@ -236,7 +246,6 @@ To prevent log flooding: ### Phase 0: Minimal Bootstrap Implement the absolute minimum to unblock development and testing: -- Simple JSON-based logging (no protobuf yet) - Basic wrapper that only handles happy path - Support for local execution only - Minimal log parsing in graph