Skip to content

docs: scope the provenance-compliance claim to platform-managed computation - #277

Closed
ttngu207 wants to merge 1 commit into
mainfrom
docs/scope-provenance-compliance-claim
Closed

ttngu207 wants to merge 1 commit into
mainfrom
docs/scope-provenance-compliance-claim

Conversation

@ttngu207

Copy link
Copy Markdown
Contributor

Summary

Scopes one sentence in comparison-to-provenance-systems.md. It read:

Compliance with industry provenance standards is ensured by the DataJoint Platform.

Unqualified, on a public page. Ensured overstates what the Platform can promise, because what an exported account carries depends on what was captured — and three cases capture less.

Why

Raised in review of platform-roadmap#228, a feature brief for provenance export whose readiness section documents the gaps. Verified against datajoint-python origin/master (v2.3.3):

  • Off-platform populate. JobsSettings (src/datajoint/settings.py:285, env prefix DJ_JOBS_) ships keep_completed=False, add_job_metadata=False, and version_method=None. A laptop run against library defaults produces no job metadata and no commit identity.
  • Tables predating the setting. add_job_metadata does not backfill — per its own description, "tables created without this setting will not receive metadata updates during populate." src/datajoint/migrate.py:632 exists for that case.
  • Manual entry. Who entered a datum, and when, is not captured at all today (platform-roadmap#226).

All three are things a provenance standard asks for. The claim as written would be read by a regulated buyer as a guarantee across the deployment.

What changed

One sentence becomes a short paragraph: the Platform supports compliance for the computation it manages, what an account carries depends on what was captured, and compliance is a property of the deployment rather than of the format.

Everything around it is unchanged — lineage lives in DataJoint's own schema, maps to OpenLineage or W3C PROV, and integrates in both directions when explicitly configured.

Not in this PR

The three capture gaps themselves. Two have platform-side remedies in flight (add_job_metadata_columns for the migration, platform-roadmap#226 for manual attribution); this PR only stops the page promising more than they currently deliver.

…tation

"Compliance with industry provenance standards is ensured by the DataJoint
Platform" stood unqualified. Ensured overstates it: what an exported account
can carry depends on what was captured, and three cases carry less.

Data populated outside the platform runs against library defaults, where
JobsSettings ships keep_completed, add_job_metadata and version_method all
off, so there is no job metadata and no commit identity. Tables declared
before add_job_metadata was enabled carry none either, since enabling it
does not backfill. And manually entered rows record no attribution at all —
who entered a datum and when is not captured today.

Rewritten to say the Platform supports compliance for the computation it
manages, and that compliance is a property of the deployment rather than of
the format. The surrounding claims are unchanged: lineage lives in
DataJoint's schema, maps to OpenLineage or W3C PROV, and integrates in both
directions when explicitly configured.

Raised in review of platform-roadmap#228, whose readiness section documents
the three cases.
@ttngu207
ttngu207 marked this pull request as draft September 17, 2026 20:48
@ttngu207 ttngu207 closed this Sep 17, 2026
@ttngu207
ttngu207 deleted the docs/scope-provenance-compliance-claim branch September 17, 2026 20:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant