Skip to content

Documentation update across data quality pages - #464

Merged
sianteesdale merged 7 commits into
mainfrom
st/update-reporting-monitoring-data-qual
Sep 22, 2026
Merged

sianteesdale merged 7 commits into
mainfrom
st/update-reporting-monitoring-data-qual

Conversation

@sianteesdale

Copy link
Copy Markdown
Contributor

What type of PR is this? (check all applicable)

  • Refactor
  • Feature
  • Bug Fix
  • Optimization
  • Documentation Update

Description

This PR updates the documentation across the two data quality pages with:

  • The new data quality category names, as per the specification. I've also included the description column from the spec in the table too
  • New wording on warning vs error vs nothing, in terms the scoring differentiation between 1-3 and 4-6
  • Updating wording on the 10 data quality dimensions

Related Tickets & Documents

Importantly, being non-authoritative is **not** a hard cap on the rest of the score — a non-authoritative provision can still independently reach _trustworthy_ (level 3) if its data quality is otherwise clean. Authoritative status only ever determines which half of the scale a provision sits in (1-3 vs 4-6), not whether it can reach the top of its half.
Authoritative status determines which half of the scale a provision sits in: 1-3 for non-authoritative provisions, 4-6 for authoritative ones. Importantly, this is **not** a hard cap on the rest of the score — a non-authoritative provision can still independently reach _verifiable_ (level 3) if its data quality is otherwise clean. Authoritative status only ever determines which half a provision sits in, not whether it can reach the top of its half.

Within each half, the specific level is set by the most severe issue found on the provision: an **error** (e.g. an invalid date) scores the bottom of the half (1 or 4); a **warning** (e.g. converting the geometry's CRS to be WGS84) scores the middle (2 or 5); and no errors or warnings scores the top of the half (3 or 6). This is our current thinking on where to draw the line between severity levels, and it may become more nuanced as the framework develops.

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's use a different example for a warning here as I'm not sure conversion will remain one... Maybe flipping a long/lat?

Also, we might want to mention here that we'll also create notice tasks for some things but these explicitly won't change the quality score.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added those in now - thanks Ben!

### Determining authoritative status

Rather than inferring provenance indirectly (e.g. via a geospatial check against a provider's boundary), authoritative status is read directly from a signal the platform already computes: every dataset's own `entity` table carries a `quality` value per entity (`none`, `some`, `indicative`, `authoritative`, `usable`, or `trustworthy` — defined with a priority ordering in the `quality` reference table). A provision counts as authoritative if any of its entities reach `authoritative` priority or above.
Rather than inferring provenance indirectly (e.g. via a geospatial check against a provider's boundary), authoritative status is read directly from a signal the platform already computes: every dataset's own `entity` table carries a `quality` value per entity, which in practice is set to either `authoritative` or `some`. A provision counts as authoritative if any of its entities are `authoritative`.

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is true as of now - I think this may change when we get further into this, but no changes needed yet. Just flagging!

@sianteesdale
sianteesdale merged commit a2a4977 into main Sep 22, 2026
1 check passed
@sianteesdale
sianteesdale deleted the st/update-reporting-monitoring-data-qual branch September 22, 2026 08:08
@sianteesdale sianteesdale mentioned this pull request Sep 22, 2026
1 of 5 tasks
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.

Update tech docs with latest data quality work

2 participants