Online templates

[chrisgorgo]

As suggested by Trey Smith https://docs.google.com/document/d/1HFUkAEE-pB-angVcYe6pf_-fVf4sCpOHKesUvfb8Grc/edit?disco=AAAABBoxE28

Here's something that would help JSON novices: for each type of JSON object you describe in your specification, provide a URL to a template document in jsoneditoronline.org. The template document would have proper example values for the keys of interest, and it would also be schema-aware (define a schema for the relevant object type, and link the template document to that schema).

Look at https://www.jsoneditoronline.org/doc/index.html - JSON schema validation. Super cool feature.

[choldgraf]

just a thought: we've been experimenting with using the JSON schema for the jupyterhub helm chart in order to generate documentation for it. I think it works relatively well! Check out the doc page here:

https://zero-to-jupyterhub.readthedocs.io/en/latest/schema.html

and the schema here:

https://github.com/jupyterhub/zero-to-jupyterhub-k8s/blob/master/jupyterhub/schema.yaml

[dorahermes]

A start has been made on the templates.

Are json schema files not just meant used to verify an existing schema? I am not sure whether they can be used to create an empty one?

[KirstieJane]

Hey @choldgraf @chrisfilo & @dorahermes - @Park-Patrick and I are going through the issues at the OHBM Hackathon today (so heads up....you might get a bunch of comments today! Don't worry about replying, we're just doing some house keeping!!)

Neither of us are super clear on what the action is on this issue - is the idea to include some help for understanding json files? I don't think I follow what the schema is etc (maybe that's because I could really benefit from this addition!)

Thanks for any additional comments/clarifications ✨