docs: reorganize data-plane and backend design by ownership - #445
Merged
Merged
Conversation
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.
Summary
Reorganize
data_plane/docsand top-leveldocsusing the same topic/ownership model as the control-plane cleanup in #444.ASAPQuery-backend now documents only backend-owned architecture, physical runtime behavior, storage, identity, and extension boundaries. ASAPPlanner-owned parsing, query-to-summary mapping, accuracy reasoning, candidate generation, and logical selection are referenced rather than re-specified.
New structure
data_plane/docsREADME.mdis the index, with content split by audience:design_docs/query-execution.md: BackendPlan-aware ingestion, routing, readiness, summary readout, and exact fallback contracts.developer_docs/extension-points.md: protocol server, adapter, and fallback-client responsibilities without file-by-file recipes.user_guide/querying-asap.md: user-facing PromQL behavior, summary-backed results, exact fallback, accuracy, freshness, and errors.top-level
docsdesign_docs/summary-storage.md: active materialization storage and lifecycle contract;design_docs/series-identity.md: active canonicalsidcontract and recovery behavior;design_docs/future-storage-and-compression.md: dormant/non-MVP persistence, compaction, backfill, service mode, compression, sampling, and profiling scopes;developer_docs/adding-summary-family.md: cross-repository ownership and backend validation checklist.Removed
TODO.md, which duplicated deleted progress/roadmap material and referenced removed files.Relevant source comments now point to the consolidated storage and identity documents.
Validation
git diff --checkdocs,data_plane/docs,control_plane/docs, and the root README;cargo fmt --all -- --checkwas attempted but is blocked by pre-existing formatting differences in siblingASAPCollector/asap-precompute-rs; no Rust behavior changed in this PR.