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

Record file structure/details in project metadata #2185

Open
tompollard opened this issue Jan 26, 2024 · 0 comments
Open

Record file structure/details in project metadata #2185

tompollard opened this issue Jan 26, 2024 · 0 comments

Comments

@tompollard
Copy link
Member

tompollard commented Jan 26, 2024

Currently, as far as I'm aware, we don't formally document the structure/details of files in the metadata of published projects.

For example, we have no structured record of details such as:

  • Folder structure
  • Lists of files
  • File types
  • File sizes
  • File contents (e.g. what columns does a CSV file contain)

There may be value in documenting these kind of details. For example, we could refer to the metadata to:

  • Support file-level data discovery.
  • Assist with loading data into appropriate cloud tools (e.g. relational databases)
  • Offer data summaries in the project description

This issue relates to #2184, which highlights a metadata format for documenting this kind of metadata.

Presumably we would want to generate the metadata around time of publication. The metadata would also need to be easy to regenerate in the rare cases where files are modified post-publication.

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

No branches or pull requests

1 participant