VHP4Safety / cloud

VHP4Safety Cloud Service Catalog
https://cloud.vhp4safety.nl/
0 stars 1 forks source link

adding comments to the template.json and another create-markdown script in r. #35

Closed ozancinar closed 1 year ago

ozancinar commented 1 year ago

Proposing some comments in the template.json file to make filling a JSON file for a (new) service easier and in a standardized way. There are also some questions and discussions about the items that we might want to consider for more clarification on the purpose of the elements in the template. These questions (from me) start with '[?OC]' in the template file.

In addition, there's a new create markdown script (for individual services for the moment) written in R that might provide some customization. I can work on writing similar scripts to create the catalog.md file and other scripts in the docs-repo to make the connection between these two repos appropriately.

egonw commented 1 year ago

@ozancinar, I approved the PR. The notes are very helpful. I left comments; please read them and let me know what you think.

What I did not understand is what the R script is for. Is this a replacement for the Groovy code? If so, is there a specific reason to replace it?