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

docs: Restructure and update landing page content #175

Closed duncandewhurst closed 1 year ago

duncandewhurst commented 1 year ago

Related issues

Description

This PR implements the structure and landing page content proposed in https://github.com/GFDRR/rdl-standard/issues/43#issuecomment-1664775244. Notably, that includes integrating the content from the old taxonomies and GED4ALL pages into the 'other standards' page and linking to it from the relevant sections of the codelist and schema reference pages. It also includes a first draft of content for the new pages in the introduction section: 'What is the RDLS?' and 'How do I implement the RDLS?'. The latter page will need to be updated once the spreadsheet template and conversion and validation tool are available online and once the how-to guide for publishing RDLS metadata is written.

Merge checklist

If you added or removed a field:

Having trouble?

See how to resolve check failures.

duncandewhurst commented 1 year ago

These changes are probably easier to review in the built documentation: https://rdl-standard.readthedocs.io/en/43-restructure/

odscjen commented 1 year ago

@duncandewhurst I merged the latest dev branch into this PR and it's caused a readthedocs failure. Running this on my own machine there was a typo introduced in reference/schema.md but fixing that made the build work properly so I'm not sure why it's now failing here

duncandewhurst commented 1 year ago

@duncandewhurst I merged the latest dev branch into this PR and it's caused a readthedocs failure. Running this on my own machine there was a typo introduced in reference/schema.md but fixing that made the build work properly so I'm not sure why it's now failing here

Ah, the reason was that this PR added a new instance of the jsonschema directive on docs/rdl/what.md, which referenced rdl_schema_0.1.json that had been renamed on dev. The reason it built OK locally is because the directive links to the built version of the schema, which would have still been available on your local machine unless you first ran make clean to delete the build folder. Whereas, on Read the Docs, the docs are built on a fresh virtual machine each time. I've fixed the link in https://github.com/GFDRR/rdl-standard/pull/175/commits/1aece4b9772ab76dba360a97f7e7b8700c2f146c

duncandewhurst commented 1 year ago

@matamadio are you happy for me to merge this or do you want to wait for @stufraser1 to review?

duncandewhurst commented 1 year ago

Agreed to merge in call with @matamadio