Update diagrams, top-level schema description and schema reference

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

16 stars 1 forks source link

Update diagrams, top-level schema description and schema reference #212

Closed duncandewhurst closed 1 year ago

duncandewhurst commented 1 year ago

Related issues

Closes #178

Description

In addition to updating the diagrams per #178, this PR also:

Updates the top-level description in the schema to align with the diagram in docs/rdl/what.md
Adds the schema descriptions for dataset, resource and each hazard component to docs/reference/schema.md

You can preview the changes here: https://rdl-standard.readthedocs.io/en/178-diagrams/reference/schema/

Merge checklist

[x] Update the changelog (style guide)
[x] Run ./manage.py pre-commit

If you added or removed a field:

[ ] Update the collapse option of the jsonschema directives for dataset, resource, hazard, exposure, vulnerability and loss on reference/schema.md

Having trouble?

See how to resolve check failures.

duncandewhurst commented 1 year ago

~~Noting that the exposure diagram may need to be updated if there are further changes in https://github.com/GFDRR/rdl-standard/pull/204~~

duncandewhurst commented 1 year ago

Based on @matamadio's feedback in yesterday's call, I've removed empty objects and arrays from the diagrams and added an explanatory sentence to describe how arrays are represented.

Here's how the changes look to the hazard diagram (since it is the most complex):

Before

After

I considered adding an extra object to each array, but I think it makes the diagram too complicated:

duncandewhurst commented 1 year ago

Since @matamadio has approved, I'm going to bypass branch protections and merge this PR so that these changes are available on dev before the workshop today. (Merging was blocked because @stufraser1's earlier review was marked as requesting changes, all of which have been addressed).