Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add .openworm.yml metadata to geppetto repositories #69

Open
mwatts15 opened this issue Nov 3, 2019 · 6 comments
Open

Add .openworm.yml metadata to geppetto repositories #69

mwatts15 opened this issue Nov 3, 2019 · 6 comments

Comments

@mwatts15
Copy link
Contributor

mwatts15 commented Nov 3, 2019

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.

@pgleeson
Copy link
Member

pgleeson commented Nov 4, 2019

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

@casperdcl
Copy link
Member

@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:

openworm_docs/build.py

Lines 190 to 208 in 4022f3c

"children": [],
"parent": [],
"inputs": [],
"outputs": [],
# TODO: use the following
# 'earnable_badges': '',
# 'members': '',
# 'tests': ''
"contributor_guide": "",
"coordinator": "",
"documentation": "",
"gitter": "",
"keywords": [],
"languages": [],
"latest_release": "",
"repo": "",
"shortdescription": "",
"latest_release_date": "",
"latest_generated_date": "",

@pgleeson
Copy link
Member

pgleeson commented Nov 4, 2019

Some suggestions for harmonising the yml files here: #70

@casperdcl
Copy link
Member

@pgleeson pgleeson added this to the 2021 update 2 milestone Apr 8, 2021
@pgleeson pgleeson modified the milestones: 2021 update 2, 2024 update 2 Jul 2, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants