search

GFDRR / rdl-standard

The Risk Data Library Standard (RDLS) is an open data standard to make it easier to work with disaster and climate risk data. It provides a common description of the data used and produced in risk assessments, including hazard, exposure, vulnerability, and modelled loss, or impact, data.
https://docs.riskdatalibrary.org/
Creative Commons Attribution Share Alike 4.0 International
13 stars 1 forks source link

[schema/documentation] Clarify the purpose of links #187

Closed odscjen closed 11 months ago

odscjen commented 1 year ago

From suggestion in https://github.com/GFDRR/rdls-spreadsheet-template/issues/3#issuecomment-1671200463 create a codelist for link.rel from https://www.iana.org/assignments/link-relations/link-relations.xhtml. Currently this is just recommended in the field description

duncandewhurst commented 1 year ago

links only exists as a standards-compliant means of declaring the version of the RDLS schema that describes the data (using the 'describedby' code) so I don't think we need to include the IANA codelist in the standard. However, we should update the schema descriptions and documentation to clarify the purpose of links. Sound good?

odscjen commented 1 year ago

That makes a lot of sense to me, @matamadio is that sufficient?

matamadio commented 1 year ago

If the only IANA codelist expected is "describedby", then I don't see the reason to allow the choice to user. The field should have that value in the template already.

duncandewhurst commented 1 year ago

Sounds good. I've created an issue on the template repo and will rename this issue to be about clarifying the purpose of links in the schema and documentation.

matamadio commented 1 year ago

Agreed and implemented (auto-populating with describedby); this can be closed.

odscjen commented 1 year ago

I'm going to leave this open to remind us to include the clarification in the guidance as well as the autopopulation now in the spreadsheet