trevorb1
commented
1 year ago Just in relation to Item 1 is the json-schema site. Using this to validate all meta-data, either in script or through GitHub Actions, would be good. Even if the meta-data is stored in a yaml file, it will still work fine (see here)
pmcwhannel
The data documentation procedure will be used to indicate how the documentation of new datasets should be executed. This procedure should indicate what information regarding the dataset should be documented and how it will be documented. This issue will need at least the following items:
Item 1: Template/schema for documentation of a dataset. The purpose of the template is to ensure all datasets are consistently documented and make it easer for Delta-E+ members to search for datasets which will be beneficial to them. The template for a given dataset should be like a homepage for that dataset. It should provide all the necessary information to understand what the dataset captures, the units of the data, the technical details (resolution, spatial coverage, etc...). Not within the scope of this issue or task but something the template should include is some sort of tagging/indexing mechanism so datasets can be discoverable by categorical tags. Please see Data Documentation Outcome Ideas for some ideas on what the template should contain.
Item 2: Procedure for using the template The procedure should outline the process of where to find the template, explain the purpose of the template and documentation of datasets, and all the steps involved in the process of creating the documentation for a new dataset.
A successful PR for this will include: