Add guidelines on metadata and FAIR principles#42
Conversation
|
Not sure how to fix the read the docs build failure |
That was a strange error indeed, but I re-ran the build and it seemed to have fixed itself 🤷🏻 |
|
I caused some merge conflicts when merging #41 so I fixed them here. |
bourque
left a comment
bourque
left a comment
There was a problem hiding this comment.
These look great! I just have a few non-blocking comments/suggestions.
| 1. **Adopt FAIR-Compliant Practices**: | ||
| - Assign persistent identifiers to datasets and metadata. | ||
| - Use rich metadata that describe datasets thoroughly. | ||
|
|
||
| 2. **Register Metadata**: | ||
| - Index metadata in searchable repositories to enhance discoverability. | ||
|
|
||
| 3. **Implement Standards for Access and Interoperability**: | ||
| - Ensure retrieval protocols are open and free. | ||
| - Use FAIR-aligned vocabularies and knowledge representation languages. | ||
|
|
||
| 4. **Provide Reuse Guidance**: | ||
| - Include detailed provenance information. | ||
| - Apply clear licenses for data usage. | ||
|
|
||
| 5. **Collaborate with FAIR Partners**: | ||
| - Follow practices adopted by FORCE11, COPDESS, and similar organizations. |
There was a problem hiding this comment.
It is strange that the bulleted lists in the previous sections all are indented in the final product on the RtD page (which looks nice!) but these are not. I'm not sure why 🤔
There was a problem hiding this comment.
I think it might be an issue with mixing ordered lists with unordered lists. When I indent the bullets more, I get the following markdown lint error MD007 Unordered list indentation
There was a problem hiding this comment.
Since metadata is mentioned in several places in this document, it might be good to cross-reference your metadata.md page somewhere in here.
|
|
||
| ### LASP Metadata Repository | ||
|
|
||
| LASP is developing the **LASP Extended Metadata Repository (LEMR)** to store and access dataset metadata: |
There was a problem hiding this comment.
I didn't either! so hopefully this information isn't out-of-date
| - **ISO 19115**: Geographic information and services. | ||
| - **SPASE**: Used in Heliophysics. |
There was a problem hiding this comment.
It might be nice to link to any official documentation for these here.
Co-authored-by: Matthew Bourque <Matthew.Bourque@lasp.colorado.edu>
Co-authored-by: Matthew Bourque <Matthew.Bourque@lasp.colorado.edu>
* Add guides for metadata and FAIR principles * add new guidelines to index.rst * Address markdown lint errors identified in PR code checks * add period to end of sentence Co-authored-by: Matthew Bourque <Matthew.Bourque@lasp.colorado.edu> * bold font to match formatting of other items in list Co-authored-by: Matthew Bourque <Matthew.Bourque@lasp.colorado.edu> * Minor formatting updates. Link to metadata guide * Reference metadata doc in FAIR pricinples guide. Add links to SPASE and ISO 19115 --------- Co-authored-by: Matthew Bourque <Matthew.Bourque@lasp.colorado.edu>
2 participants
Added two guides pulled from the data management section in confluence.