openworm_docs icon indicating copy to clipboard operation
openworm_docs copied to clipboard

Add .openworm.yml metadata to geppetto repositories

Open mwatts15 opened this issue 6 years ago • 6 comments

Automated repository crawler for the documentation would be lacking several geppetto libraries. This issue is to add a basic .openworm.yml to libraries in the geppetto project that indicates the relationships between them.

mwatts15 avatar Nov 03 '19 22:11 mwatts15

@mwatts15 Is there a doc/file somewhere outlining all the mandatory/optional fields in the .openworm.yml?

pgleeson avatar Nov 04 '19 10:11 pgleeson

@pgleeson I talked with @cheelee and understand there isn't (atm). But I've looked through all the files and found these keys so far: https://github.com/openworm/openworm_docs/blob/4022f3cd0b0cd36def49723ad265eb3a6585afe6/build.py#L190-L208

casperdcl avatar Nov 04 '19 10:11 casperdcl

See https://github.com/openworm/org.geppetto/blob/master/.openworm.yml and https://github.com/openworm/openworm_docs/blob/master/.openworm.yml for ideas...

casperdcl avatar Nov 04 '19 11:11 casperdcl

Thanks @casperdcl. FYI I've added/updated yml files here:

https://github.com/openworm/c302/blob/master/.openworm.yml https://github.com/openworm/CElegansNeuroML/blob/master/.openworm.yml https://github.com/openworm/JohnsonMailler_MuscleModel/blob/master/.openworm.yml https://github.com/openworm/muscle_model/blob/master/.openworm.yml https://github.com/openworm/hodgkin_huxley_tutorial/blob/master/.openworm.yml

pgleeson avatar Nov 04 '19 13:11 pgleeson

Some suggestions for harmonising the yml files here: https://github.com/openworm/openworm_docs/issues/70

pgleeson avatar Nov 04 '19 13:11 pgleeson

OK latest version https://818-12814245-gh.circle-artifacts.com/0/home/circleci/repo/site/gsod19/repos/index.html

casperdcl avatar Nov 05 '19 14:11 casperdcl