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

Community partner documentation #355

Open
esgomezm opened this issue Sep 27, 2023 · 0 comments
Open

Community partner documentation #355

esgomezm opened this issue Sep 27, 2023 · 0 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@esgomezm
Copy link
Contributor

Hi there, I copy some feedback from a team that's trying to fill the steps to become a community partner:

At the moment I could tell you that, in the Bioimage model zoo page I had more or less the general idea of how everything works, as you describe in the "+" button to become a community partner (CP): that it works with RDF, that they are basically YAML files, that everything goes to the BioImage center repo and that the continuous integration (CI) service is in charge of taking the files from your repo and integrating them. But you don't put anything about what are the steps one has to take to do the main things of a CP which I understand are: export, consume and maintenance (with the CI). I think there should be a clear description of the steps one has to take to do those 3 things (if they are the 3 main things).

For example, for the task of exporting models, I see that in https://github.com/bioimage-io/collection-bioimage-io, which is the page you put in the description of how to make you a CP, there is an example video of how to insert models in the web, but I understand that for that you will have to do quite a few things before (i.e. something that has to do with a trigger_partner_wf.yaml to be able to generate a workflow from your code). I don't see clearly the steps I have to take.

I understand that what you have passed me now, https://github.com/bioimage-io/core-bioimage-io-python, is the repo that I have to use to be able to export/consume the models. But this link you have passed it to me, it is not in the explanation of how to become a CP is not it? That's what I mean by explaining the steps to take for each of the "tasks" of a CP.

The information about the tools provided in the BioImage Model Zoo that new software could use is missing. An idea could be to say "This is what we expect a CP to do and we provide you these tools that can be used for that, in this, this, and this other way".

@cfusterbarcelo @oeway

@esgomezm esgomezm added the documentation Improvements or additions to documentation label Oct 11, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants