Retire strict_provenance docs; drop provenance terminology#199
Open
dimitri-yatsenko wants to merge 2 commits into
Open
Retire strict_provenance docs; drop provenance terminology#199dimitri-yatsenko wants to merge 2 commits into
dimitri-yatsenko wants to merge 2 commits into
Conversation
Match datajoint-python's removal of the strict_provenance runtime guardrail, and align the docs with the decision to keep provenance terminology out of DataJoint's own documentation. DataJoint implements the relational workflow model — data integrity, consistency, lineage, and reproducibility; provenance is a platform-level compatibility concern documented separately. - Rename reference/specs/provenance.md -> trace.md; rewrite it as the spec for the upstream read surface (Diagram.trace + self.upstream), removing the strict_provenance section entirely and reframing the "read/write boundary" in lineage/reproducibility terms. - about/whats-new-23.md: reframe the "provenance trinity" as the trace + self.upstream pair; drop the strict_provenance subsection and adoption step; retarget links to trace.md and the make() contract. - mkdocs.yaml: nav "Provenance Trace & Strict Provenance" -> "Upstream Trace". - Sweep "provenance" from the conceptual and tutorial pages (index, about/index, relational-workflow-model, normalization, comparison-to-workflow-languages, schema-as-workflow-specification, data-pipelines, faq, and three tutorial notebooks), replacing it with "lineage"/"reproducibility"/"traceability" as fits each context.
Add mkdocs-redirects so reference/specs/provenance/ (renamed to reference/specs/trace/ when the provenance framing was retired) keeps resolving instead of 404-ing.
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 counterpart to datajoint/datajoint-python#1489 (retire the
strict_provenanceruntime guardrail), and alignment with the decision to keep provenance terminology out of DataJoint's own documentation.DataJoint implements the relational workflow model — data integrity, consistency, lineage, and reproducibility. "Provenance" is associated with a different class of systems; DataJoint's provenance compatibility features live in the platform and are documented separately (
datajoint-provenance). So the public docs use the model's native vocabulary: lineage, reproducibility, traceability.Changes
Retire
strict_provenance:reference/specs/provenance.md→reference/specs/trace.mdand rewrite it as the spec for the upstream read surface (Diagram.trace+self.upstream) — thestrict_provenancesection (§3), config docs, examples, and references are removed; the "read/write boundary" is reframed in lineage/reproducibility terms.about/whats-new-23.md: reframe the "provenance trinity" as thetrace+self.upstreampair, drop thestrict_provenancesubsection and adoption step, retarget links.mkdocs.yaml: nav "Provenance Trace & Strict Provenance" → "Upstream Trace".Drop "provenance" terminology across the conceptual and tutorial pages (
index,about/index,relational-workflow-model,normalization,comparison-to-workflow-languages,schema-as-workflow-specification,data-pipelines,faq, and three tutorial notebooks) — replaced with "lineage" / "reproducibility" / "traceability" per context.Verification
grepconfirms no "provenance" terminology remains in tracked source (src/), and no links point to the oldspecs/provenance.mdpath.llms-full.txtis a generated, untracked build artifact — regenerated on build.)Published URL
reference/specs/provenance/becomesreference/specs/trace/. This PR addsmkdocs-redirects(and themkdocs-redirectsbuild dependency) so the old URL redirects to the new page instead of 404-ing.