Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

adding normative statement about source information #636

Merged
merged 4 commits into from
Apr 16, 2024
Merged

Conversation

kathryn-ods
Copy link
Contributor

Overview

  • What does this pull request do? adds a normative requirement that statements should include source info
  • How can a reviewer test or examine your changes?
  • Who is best placed to review it?

Closes #537

Translations

Documentation & Release

@kathryn-ods kathryn-ods requested a review from kd-ods April 12, 2024 14:29
@kathryn-ods
Copy link
Contributor Author

@kd-ods imo this is the only thing in the sources and annotations page that isn't otherwise covered in the schema/docs. See comments in #537 for more detail.

Copy link
Collaborator

@kd-ods kd-ods left a comment

Choose a reason for hiding this comment

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

If we're deleting the provenance page, I feel we need to do something with the verification-related content... and also the point about using annotations to record data processing/cleaning/enrichment.

On the first, maybe just an edit to the source.type field description, to:

"The types of the source, using the sourceType codelist. Include 'verified' in the array if the information in the Statement has undergone a verification process."

On the second, I actually think this is a bigger issue. If annotations are to be used to note data cleaning etc, then those reasons should be in the motivations codelist. BUT let's not get bogged down in that for this release. We can spin up a new issue with the title "Consider adding 'cleaning' and 'enrichment' to the motivations codelist" with some background and rationale. Then come back to it in the future.

What do you think?

schema/statement.json Outdated Show resolved Hide resolved
kathryn-ods and others added 2 commits April 15, 2024 14:29
Co-authored-by: kd-ods <35495305+kd-ods@users.noreply.github.com>
@kathryn-ods
Copy link
Contributor Author

@kd-ods have made those changes and made #638 for the annotations issue

@kathryn-ods kathryn-ods requested a review from kd-ods April 15, 2024 13:41
Copy link
Collaborator

@kd-ods kd-ods left a comment

Choose a reason for hiding this comment

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

Great. This is good to go.

@kathryn-ods kathryn-ods merged commit 6537fed into main Apr 16, 2024
2 checks passed
@kathryn-ods kathryn-ods deleted the source-edits branch April 16, 2024 12:10
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.

Move old 'Sources and annotations' page content to 'Schema reference' page
2 participants