search

openproblems-bio / website

Website hosted at https://openproblems.bio
Creative Commons Attribution 4.0 International
3 stars 7 forks source link

Discuss `task_info.yaml` in docs #268

Closed scottgigante-immunai closed 6 months ago

scottgigante-immunai commented 1 year ago

There's currently no mention of this file at all. I don't know, for example, what are valid roles.

KaiWaldrant commented 1 year ago

see https://main--openproblems.netlify.app/documentation/create_task/define_task.html

rcannood commented 1 year ago

To elaborate a bit further on this:

There's currently no mention of this file at all.

I agree with Kai here, it's already mentioned in the '[Define task](see https://main--openproblems.netlify.app/documentation/create_task/define_task.html)' documentation

I don't know, for example, what are valid roles.

However, I also think this documentation could be expanded upon, because right now the documentation just shows you the format of a task_info.yaml file without describing each of the fields. Let's reopen this until we have more extensive descriptions in place.

scottgigante-immunai commented 1 year ago

Ah, I was looking in https://main--openproblems.netlify.app/documentation/create_task/design_api.html . Might be worth assuming that people won't read the docs end-to-end (e.g. if my task is already well-defined) and putting a mention of this file in the "design the API" section, even if it's just referencing the fact that it was created in the previous step, especially since it's defined in the API directory.