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
16 stars 1 forks source link

Update schema reference #120

Closed duncandewhurst closed 1 year ago

duncandewhurst commented 1 year ago

Related issues

Description

This PR updates the reference documentation (formerly known as the data model section). The schema tables are now generated from the schema as part of the Sphinx build so they will always be up-to-date and manage.py includes a pre-commit script to update the sub-schema and codelist reference sections.

The diagrams, explanatory text and examples will need updating once the schema updates are done, but I don't think that should be a blocker to getting this PR merged.

I've temporarily commented out the code in manage.py that adds the lists of references to the sub-schema reference and codelist reference as this requires some more work due to the structure of the RDLS schema and I understand that finishing off the schema changes is the priority.

Merge checklist

duncandewhurst commented 1 year ago

Preview: https://rdl-standard.readthedocs.io/en/schema-reference/reference/

duncandewhurst commented 1 year ago

I started correcting some language and then realised it was pointless as most of the component pages are going to need rewritten anyway as they are now incorrect and refer to fields etc that have been removed/renamed/resituated.

Yep, as I mentioned in PR description, the diagrams, explanatory text and examples will need updating once the schema updates are done, but I don't think that should be a blocker to getting this PR merged.

@matamadio @stufraser1, over to you to review. Per the above, there's no need to review the text on schema.md from line 13 onwards as I copy-pasted it from the old data model documentation pages. You can preview the built documentation here: https://rdl-standard.readthedocs.io/en/schema-reference/reference/

duncandewhurst commented 1 year ago

All sounds good. +1 to using JSON snippets and full files for examples. I'll merge the PR and copy your comment to #43.