MDE aligned to RDLS v1.0 - Review

[matamadio]

It is coming together. So far I've managed to align to new schema structure and functionalities.
Still doing bugfixes, and might benefit from ODS's code check for optimization, but it seems to work correctly for the most part.

Demo at: https://gfdrr.github.io/CCDR-tools/_static/RDL_MDE_v1.html

Since RDLS v1.0 introduces breaking changes compared to v0.2, this version of MDE is not retro-compatible.

Depends on #390

[bennyistanto]

Bug 1, Attribution

In MDE v1, I tried to fill in the mandatory attribution with some additional information for testing. See the picture below.

And the Live Preview & Validation provides the structure below.

{
  "datasets": [
    {
      "id": "rdls_hzd-drc_gca_moyiclimate",
      "title": "Climate Hazard Assessment for DRC Moyi Power Project",
      "description": "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.",
      "risk_data_type": [
        "hazard"
      ],
      "publisher": {
        "name": "Global Center on Adaptation (GCA)",
        "url": "https://gca.org"
      },
      "version": "3.0",
      "purpose": "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.",
      "project": "DRC Moyi Power Project - Climate Adaptation",
      "details": "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.",
      "contact_point": {
        "name": "GCA Infrastructure & Nature-Based Solutions",
        "email": "infrastructure@gca.org"
      },
      "creator": {
        "name": "Lobelia Earth",
        "url": "https://lobelia.earth"
      },
      "spatial": {
        "scale": "sub-national",
        "countries": [
          "COD"
        ],
        "bbox": [
          17.94,
          -2.24,
          30.69,
          5.51
        ],
        "gazetteer_entries": [],
        "geometry": {
          "coordinates": []
        }
      },
      "license": "https://gca.org/terms-of-use",
      "attributions": [
        {
          "id": "attr_gca",
          "role": "principal_investigator",
          "entity": {
            "name": "Global Center on Adaptation (GCA)",
            "url": "https://gca.org"
          }
        },
        {
          "id": "attr_lobelia",
          "role": "processor",
          "entity": {
            "name": "Lobelia Earth",
            "url": "https://lobelia.earth"
          }
        },
        {
          "id": "attr_haskoning",
          "role": "processor",
          "entity": {
            "name": "Royal HaskoningDHV",
            "url": "https://www.royalhaskoningdhv.com"
          }
        },
        {
          "id": "attr_miga",
          "role": "funder",
          "entity": {
            "name": "Multilateral Investment Guarantee Agency (MIGA), World Bank Group",
            "url": "https://www.miga.org"
          }
        },
        {
          "id": "attr_gridworks",
          "role": "funder",
          "entity": {
            "name": "Gridworks SA",
            "url": "https://www.gridworks.com"
          }
        }
      ],
...
...

Next, I save the JSON as a file and load it into MDE again. Seems the Attribution failed to get the required field into the Editor.

[matamadio]

• Attributions bug solved on latest release: https://gfdrr.github.io/CCDR-tools/_static/RDL_MDE_v1.html

@duncandewhurst where should I place the editor within this repo so that it gets accessible on build?

[duncandewhurst]

I recommend that we keep the editor in a separate repo as it's a software tool rather than part of the standard's schema and documentation. It could be a lot of work to integrate the build of the editor with the build of the docs.

[matamadio]

The "build" or update of the MDE doesn't occur on a repo; the repo just holds the working html file. We just need a "static" folder that preserve the file on published branch. If not rdl-standard, I can use the jkan repo.

[duncandewhurst]

In that case, we can put it in docs/_static and it'll be copied to built documentation. I've done that on a new branch named mde in #430 so you can check that it works as expected: https://docs.riskdatalibrary.org/en/mde/_static/RDL_MDE_v1.html

We should check with @radix0000 that this is a sensible approach from a technical perspective, and also whether it will work for you in terms of maintaining the MDE (i.e. you'll need to make PRs on this repo for any changes).

[matamadio]

(i.e. you'll need to make PRs on this repo for any changes).

You mean I can't push directly to main because it is the PR that triggers the rebuild action?
That seems fine when reaching a stable version of MDE. Before that, I'll keep the testing and debug on my repo.

[matamadio]

Updated https://gfdrr.github.io/CCDR-tools/_static/RDL_MDE_v1.html

• Added links to example in guidance from info collapsible.
• Filtering of classification schemes dropdowns based on category
• Debug links url to codelists

[duncandewhurst]

(i.e. you'll need to make PRs on this repo for any changes).

You mean I can't push directly to main because it is the PR that triggers the rebuild action? That seems fine when reaching a stable version of MDE. Before that, I'll keep the testing and debug on my repo.

No, just that the various live branches (e.g. 0.3) and staging branches (e.g. 1.0-dev) are protected, so you won't be able to update the MDE without creating a PR.

Anyway, sounds good to just update the HTML file once you are happy with it - we can keep the PR that I created in draft until then.

Also, as part of the same PR, we can add a link to the MDE in the navigation menu of the docs site.

[duncandewhurst]

#433 adds a link to the MDE in its current location, which will need updating depending on the resolution of this issue. At the same time we should check for any other MDE links in the documentation.

[radix0000]

@matamadio Just checking that you have finished with updating https://gfdrr.github.io/CCDR-tools/_static/RDL_MDE_v1.html and I should start looking at it.

[matamadio]

I'm fixing it on a daily basis, while testing on examples. Overall functional, but can be improved:

• A few bugs on validation, read and file export
• Some codelists to be improved, some fields to change mandatory state
• Fixing auth required for cat publish functionality

I'll try to solve those and then greenlight.