You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository has been archived by the owner on Aug 5, 2021. It is now read-only.
Rather than having the source for the code.json schema be in the final HTML directly, it would be beneficial to maintain the metadata schema in it's own JSON schema file.
This has been discussed in a few places now (#196, #187), as well as:
Yes, for now, changes to the schema revolve around changing that HTML file. I would take your suggestion a bit further - the core file should be json (in the json-schema format). If the file is more machine-readable, we can apply automated tests and it makes it far less likely that human errors will be introduced. Any HTML, markdown, or sample json can also be generated based upon the schema file.
-- @michael-balint on #217 (comment)
The text was updated successfully, but these errors were encountered:
To be honest, I think we need both. It's been really interesting working with civil servants at the agencies who have hugely varying levels of technical fluency, but need to understand how to comply. My not-rigously-validated hypothesis is that less technical folks really need the HTML view to get oriented. json-schema is really great but it is only human readable if you already know what json is at some basic level.
@mattbailey0 - Yes, the suggestion is to have both, but compile the HTML, markdown, etc via the json-schema. This way you get the best of everything - no more human errors in the HTML, but someone can suggest changes to the schema via the HTML (and someone on the code.gov team would translate that to the json-schema).
Rather than having the source for the
code.json
schema be in the final HTML directly, it would be beneficial to maintain the metadata schema in it's own JSON schema file.This has been discussed in a few places now (#196, #187), as well as:
The text was updated successfully, but these errors were encountered: