Generate a PDF and online documentation for the schemas on CI run
This was decided in a CCT1 meeting on 02.09.2022.
It should be fairly simple to do:
possible ways:
-
https://github.com/adobe/jsonschema2md (schemas -> md -> pdf) the md can be displayed directly on gitlab pages/docs page for this repo, or on a website/information portal or where ever. For the MD to pdf one could use the HMC workflow from data commons which exists.
-
https://github.com/bootprint/bootprint-json-schema (schemas -> html), there one could use a custom css style cheat or what ever. the html result can then be exported to x (pdf and co) through a usual static side generator (example sphinx or jekyl)
This should be done with each CI run on each change, to check this this is properly build. The PDF, html, md can then be downloaded as a pipeline artifact.