OBOFoundry.github.io icon indicating copy to clipboard operation
OBOFoundry.github.io copied to clipboard

Document OBO NOR Dashboard updated process

Open matentzn opened this issue 1 year ago • 6 comments

I have now completely automated the OBO NOR Dashboard process, which makes it possible for anyone in OBO to run the dashboard. This is how it works.

  1. Whenever the dashboard config is edited (https://github.com/OBOFoundry/obo-nor.github.io/blob/master/dashboard-config.yml), the dashboard will automatically be rebuild. A pull request will be created which will need to be merged (that step is easy to manage and a protective measure against failures to build the dashboard, but also as a way to monitor changes in the new requests)
  2. Every Monday the pipeline is run as well, to keep it generally up to date.

I think it is probably a lot to ask NOR requestors to add their ontology to the config, but if we could justify it, this is how we would instruct them:

  1. Go to https://github.com/OBOFoundry/obo-nor.github.io/blob/master/dashboard-config.yml
  2. Hit the edit button (the pencil)
  3. Scroll down to the ontologies: field.
  4. Add your ontology metadata, analogously to how the other ontologies appear. Be careful with using the identical indentation.
  5. Click "Suggest changes"

The same workflows applies when people want to update their metadata. An advantage here is that this:

  1. Reduces the burden on us and
  2. Gives a flavour of the kind of participation we expect moving forward.

The downside is it could be a barrier for some people with zero technical experience.

I personally think the advantages of having NOR requestors managing this themselves outweigh this concern.

Also, we can offer this as an OBO service: Not only NOR people, but anyone in the world can add their ontology there to be checked! Happy for you to offer that somewhere.

matentzn avatar Aug 20 '22 06:08 matentzn

This is amazing! Totally agree to automate everything.

cthoyt avatar Aug 20 '22 07:08 cthoyt

This sounds great! Nico, you added "attn: OFOC call" -- what specifically do you want to discuss during the call, or is it just that you want to announce this? Do we have to decide globally whether these things need to be automated, or can it be left as optional (e.g. ask NOR requestors to manage the process of adding their ontology to the dashboard config, but if they lack the technical expertise, we can help them with it)?

nlharris avatar Sep 04 '22 06:09 nlharris

That was already raised at an ofoc all. Action item remaining:

  • [ ] create a documentation page(s) that reflect the above information. This is partially instruction for submitters on how to change the metadata for the dashboard, and partially an instruction for the OBO Foundry TWG on how the automatic updates work.

matentzn avatar Sep 04 '22 10:09 matentzn

We are the developers of the FIDEO ontology. We have noticed in the configuration file of the dashboard "https://raw.githubusercontent.com/OBOFoundry/OBOFoundry.github.io/master/registry/ontologies.yml" that the repository is not correct. The official repository of the FIDEO ontology is "https://gitub.u-bordeaux.fr/erias/fideo". Could you please update the configuration file to keep our ontology up to date?

repository: https://gitub.u-bordeaux.fr/erias/fideo title: Food Interactions with Drugs Evidence Ontology tracker: https://gitub.u-bordeaux.fr/erias/fideo/issues

rabiaazzi avatar Nov 23 '22 13:11 rabiaazzi

@rabiaazzi please update https://github.com/OBOFoundry/OBOFoundry.github.io/blob/master/ontology/fideo.md yourself by making a pull request! The ontology metadata is generally curated by the ontology owners.

matentzn avatar Nov 23 '22 13:11 matentzn

@rabiaazzi please update https://github.com/OBOFoundry/OBOFoundry.github.io/blob/master/ontology/fideo.md yourself by making a pull request! The ontology metadata is generally curated by the ontology owners.

Thank you for your reply.

rabiaazzi avatar Nov 23 '22 13:11 rabiaazzi