oda-hub / dispatcher-plugin-nb2workflow

0 stars 1 forks source link

add authorship and acknowledgements retrieved from the backend #70

Open volodymyrss opened 1 year ago

volodymyrss commented 1 year ago

need to use all authors

can add extra metadata by adding this to parameters cell:

# oda:author_name "Marco Tucci" .
dsavchenko commented 1 year ago

Concerning acknowledgements, it's implemented in https://github.com/oda-hub/oda-bot/pull/27 via adding a file acknowledgements.md to the repo.

dsavchenko commented 1 year ago

Adding either authorship or acknowledgements text via annotations to the .ipynb have a disadvantage: they should be the same throughout the repo, as different notebooks correspond to different 'products' of the same instrument

volodymyrss commented 1 year ago

I might be better to eventually provide it from backend, this would allow to expose it in oda-api too. If we add authors anyway, we could as well add acknowledgements.

volodymyrss commented 1 year ago

Adding either authorship or acknowledgements text via annotations to the .ipynb have a disadvantage: they should be the same throughout the repo, as different notebooks correspond to different 'products' of the same instrument

if returned from the backend it can be done per product. But ok, maybe it can be on oda.yaml or something.

dsavchenko commented 1 year ago

if returned from the backend it can be done per product

It's implemented per-instrument in the frontend. It's unlikely to have a need in per-prod authorship.

dsavchenko commented 1 year ago

Still, it will be good to have all this info via oda_api. Just requires changes both in dispatcher and in oda_api. Then, all 'static' plugins will need to be updated with the info

volodymyrss commented 1 year ago

if returned from the backend it can be done per product

It's implemented per-instrument in the frontend. It's unlikely to have a need in per-prod authorship.

Is it really? It is shown along with product.

dsavchenko commented 1 year ago

But it's set for the whole instrument on installation e.g. https://github.com/oda-hub/mmoda-frontend-module/blob/3d6ee66289a9865ef83315aeb4da4c788412a1a6/instruments/mmoda_antares/mmoda_antares.install#L46

volodymyrss commented 1 year ago

I guess it was just a workaround. It was put near the product for a reason. But, for now, we can just put it per instrument.