search

glossarist / concept-model

Glossarist Concept model
1 stars 0 forks source link

feat: adding yaml schema for glossarist model v2 #33

Closed HassanAkbar closed 1 year ago

HassanAkbar commented 1 year ago

Create the YAML Schema for glossarist v2 model

closes #30

ronaldtse commented 1 year ago

@HassanAkbar can you add the field description etc (and examples) to this schema file? Thanks!

HassanAkbar commented 1 year ago

Can you please help add field descriptions and examples? Also, add a workflow to render the YAML Schema into HTML documentation. Thanks!

Sure, @ronaldtse I’m currently working on that.

HassanAkbar commented 1 year ago

@ronaldtse I've added description and examples to the yaml schema files. To generate the html site through workflow, can I use json-schema-for-humans, or do you recommend some other tool for that?

ronaldtse commented 1 year ago

@ronaldtse I've added description and examples to the yaml schema files. To generate the html site through workflow, can I use json-schema-for-humans, or do you recommend some other tool for that?

Yes of course, that's great. Thanks!

HassanAkbar commented 1 year ago

@ronaldtse Can you review this and let me know If we need to add something else in this PR?

Also, some keys in the schema are in camel casing and some are in snake casing, should I start implementing it in glossarist or should I wait for the finalization of the convention?

ronaldtse commented 1 year ago

@HassanAkbar let's do all snake case for the schema. We can add a duplicate schema with all camelcase.

HassanAkbar commented 1 year ago

@ronaldtse I've updated the PR to use snake_casing for attributes, it is now ready for review.

ronaldtse commented 1 year ago

This is good to go. Thank you @HassanAkbar !

Here's a followup task: