publicdata/j40-cejst-2
1
0
Fork 0
mirror of https://github.com/DOI-DO/j40-cejst-2.git synced 2025-02-23 10:04:18 -08:00
Code Issues Projects Releases Packages Wiki Activity Actions

Fix broken links in data roadmap

Browse source
This commit is contained in:
Shaun Verch 2021-12-08 13:53:54 -05:00
parent 27f7d42d01
commit 839fbfad0b
1 changed files with 5 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
data/data-roadmap/README.md
View file

@ -39,19 +39,19 @@ between different options for data in the data roadmap.
In order to support a process of peer review on edits and updates, these details are In order to support a process of peer review on edits and updates, these details are
tracked in one `YAML` file per data set description in the directory tracked in one `YAML` file per data set description in the directory
[data_roadmap/data_set_descriptions](data_roadmap/data_set_descriptions). [data_set_descriptions](data_set_descriptions).
Each data set description includes a number of fields, some of which are required. Each data set description includes a number of fields, some of which are required.
The schema defining these fields is written in [Yamale](https://github.com/23andMe/Yamale) The schema defining these fields is written in [Yamale](https://github.com/23andMe/Yamale)
and lives at [data_roadmap/data_set_description_schema.yaml](data_roadmap/data_set_description_schema.yaml). and lives at [data_set_description_schema.yaml](data_set_description_schema.yaml).
Because `Yamale` does not provide a method for describing fields, we've created an Because `Yamale` does not provide a method for describing fields, we've created an
additional file that includes written descriptions of the meaning of each field in additional file that includes written descriptions of the meaning of each field in
the schema. These live in [data_roadmap/data_set_description_field_descriptions.yaml](data_roadmap/data_set_description_field_descriptions.yaml). the schema. These live in [data_set_description_field_descriptions.yaml](data_set_description_field_descriptions.yaml).
In order to provide a helpful starting point for people who are ready to contribute In order to provide a helpful starting point for people who are ready to contribute
ideas for a new data set for consideration, there is an auto-generated data set ideas for a new data set for consideration, there is an auto-generated data set
description template that lives at [data_roadmap/data_set_description_template.yaml](data_roadmap/data_set_description_template.yaml). description template that lives at [data_set_description_template.yaml](data_set_description_template.yaml).
# Steps to add a new data set description: the "easy" way # Steps to add a new data set description: the "easy" way
@ -68,7 +68,7 @@ contribute a new data set description to the data roadmap:
1. Research and learn about the data set you're proposing for consideration. 1. Research and learn about the data set you're proposing for consideration.
2. Clone the repository and learn about the [contribution guidelines for this 2. Clone the repository and learn about the [contribution guidelines for this
project](../docs/CONTRIBUTING.md). project](/CONTRIBUTING.md).
3. In your local version of the repository, copy the template from 3. In your local version of the repository, copy the template from
`data_roadmap/data_set_description_template.yaml` into a new file that lives in `data_roadmap/data_set_description_template.yaml` into a new file that lives in