alphagov / data-standards-authority

Collaboration space for working on data standards and guidance for the DSA
https://alphagov.github.io/data-standards-authority/
Other
24 stars 11 forks source link

WIP: Use consistent schema for standards' pages #85

Closed jamietanna closed 2 years ago

jamietanna commented 2 years ago

As a step towards being able to produce metadata for the standards pages, we should use a consistent model across our standards.

To do this, we add a JSON schema for the standards, which attempts to make as much required and formatted appropriately.

This requires we:

This uses the json-schema library, as it's got nice error reporting, but unfortunately is stuck on draft-04 of JSON Schema.

TODO:

jamietanna commented 2 years ago

Removing classification makes https://alphagov.github.io/data-standards-authority/standards-catalogue/standards/ 's view odd - do we know what we'd want to put in there instead? Or re-add Classification as an enum?

arnau commented 2 years ago

Removing classification makes https://alphagov.github.io/data-standards-authority/standards-catalogue/standards/'s view odd - do we know what we'd want to put in there instead? Or re-add Classification as an enum?

What attribute are we settling in for classifications? topic, subject, keywords? Whichever, I would put it in the table.

The enum is another issue. The list of valid values should probably be open-ended or validated against the actual source (e.g. table Topic in the Erd diagram)

jamietanna commented 2 years ago

Closing as we've used separate PRs to perform this work