feat: ✨ explain data package vs Data Package in glossary#374
Open
lwjohnst86 wants to merge 1 commit into
Open
Conversation
Member
Author
martonvago
suggested changes
Jun 16, 2026
martonvago
left a comment
martonvago
left a comment
Contributor
There was a problem hiding this comment.
Nice, just minor comments
| core project functionalities as a single conceptual unit. | ||
|
|
||
| ## Data Resource | ||
| ## Data Package (uppercase) {#data-package-uppercase} |
Contributor
There was a problem hiding this comment.
Nitpicky comment, but isn't this title case rather than uppercase (= all caps)?
|
|
||
| Always in proper case. Use this to refer to the data layer of the framework and | ||
| its contents. | ||
| When we use the formal noun "Data Package" (or more explicitly "Data Package |
Contributor
There was a problem hiding this comment.
Maybe "proper name" / "noun" or "formal name"?
|
|
||
| We also don't refer to a folder that contains a `datapackage.json` file as a | ||
| "Data Package" as we are *not* referring to the specification in that case. | ||
| Instead, we might refer to it as a "data package" (lowercase) as it is referring |
Contributor
There was a problem hiding this comment.
Suggested change
| Instead, we might refer to it as a "data package" (lowercase) as it is referring | |
| Instead, we might refer to it as a "data package" (lowercase) as we are referring |
Or: as it is a set of...
| We also don't refer to a folder that contains a `datapackage.json` file as a | ||
| "Data Package" as we are *not* referring to the specification in that case. | ||
| Instead, we might refer to it as a "data package" (lowercase) as it is referring | ||
| to the set of files and folders that contain data and metadata, that happens to |
Contributor
There was a problem hiding this comment.
Suggested change
| to the set of files and folders that contain data and metadata, that happens to | |
| to a set of files and folders that contains data and metadata and happens to |
| ## Data Resource (uppercase) {#data-resource-uppercase} | ||
|
|
||
| When we use the formal noun "Data Resource", we are referring to the [Data | ||
| Package specification](https://datapackage.org) and how they define a "data |
Contributor
There was a problem hiding this comment.
Suggested change
| Package specification](https://datapackage.org) and how they define a "data | |
| Package specification](https://datapackage.org) and how it defines a "data |
| ## data package (lowercase) {#data-package-lowercase} | ||
|
|
||
| The term "package" is a general term that has been used in many different | ||
| contexts to refer to any bundling of things together to make it easier to |
Contributor
There was a problem hiding this comment.
Suggested change
| contexts to refer to any bundling of things together to make it easier to | |
| contexts to refer to any bundling of things together to make them easier to |
| manage, distribute, and (re)use. So appending "data" to "package" is a common | ||
| way of referring to any bundling of data and is not unique to "Data Package" | ||
| (uppercase) as defined in the Data Package specification. Unfortunately, this | ||
| can cause some confusion people could use "data package" (lowercase) to mean a |
Contributor
There was a problem hiding this comment.
Suggested change
| can cause some confusion people could use "data package" (lowercase) to mean a | |
| can cause some confusion: people could use "data package" (lowercase) to mean a |
| several files, one for each person (and potentially for each day the monitor was | ||
| used). | ||
|
|
||
| We avoid the term "data resource" (lowercase) as it isn't a clearly term and |
Contributor
There was a problem hiding this comment.
Suggested change
| We avoid the term "data resource" (lowercase) as it isn't a clearly term and | |
| We avoid the term "data resource" (lowercase) as it isn't a clearly defined term and |
github-project-automation
Bot
moved this from In Review
to In Progress
in Product development
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
2 participants
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.
Description
So we internally can align here. Also so that we can keep using data package as we potentially use other specs other than Data Package (e.g. data-dict.yaml).
Needs a thorough review.
Checklist
just run-all