search

geneontology / project-management

Tracking project metadata in the GO as issues.
2 stars 0 forks source link

Refactor GO_REF deployment #33

Closed pgaudet closed 5 months ago

pgaudet commented 1 year ago
Project link

https://github.com/orgs/geneontology/projects/171

Project description

The purpose of this project is to refactor the GO_REFs file so that it is generated from a schema-controlled (LinkML) YAML file, which then generates and publishes to an updated (PURL) location.

PI

Chris

Project owner (PO)

Pascale

Technical lead (TL)

Seth

Other personnel (OP)

Patrick; Seth

Technical specs

Covered in previous iteration and tickets ~GO_REF deployment tech specs~

Other comments

N/A

kltm commented 1 year ago

Going to say this is fine for the moment, as we're going to attempt to fly through this.

kltm commented 1 year ago

@pgaudet , @sierra-moxon may have time for this.

kltm commented 8 months ago

Talking to @pgaudet, this is ready again and waiting for resources ("Resourcing").

kltm commented 7 months ago

Making sure that @pkalita-lbl is tagged on.

kltm commented 7 months ago

@pgaudet The project issues have been refreshed after a review with @pkalita-lbl, who put together a new (and very nice) plan. The remaining item is to work out grossly how long this might take. @pkalita-lbl, feel free to give any thoughts here, otherwise I'll chat with you on slack or somewhere and we can think it through.

pgaudet commented 7 months ago

Looks good. I commented on the implementation plan, @pkalita-lbl if you could have a look and reply to my questions that'd be great.

Pascale

pkalita-lbl commented 7 months ago

@pgaudet I think I got to all of your questions. If I missed something or you need more details please let me know.

@kltm Given my current time allocation I could see picking off about one issue in this project per week. That would wrap up all the work around mid-April.

kltm commented 5 months ago

@pgaudet, @pkalita-lbl is getting close; we now have a functional and automated location at https://geneontology.org/gorefs .

With that, I wanted to know if you had any feedback on the URLs. Naturally, the official PURLs will be clean (https://github.com/OBOFoundry/purl.obolibrary.org/blob/master/config/go.yml#L76-L80), but for day to day use (bookmarks), you may want something that fits our normal usage.

So, we currently would have https://geneontology.org/gorefs/go_ref0000051.html. I wanted to make sure that go_ref was preferred over other variants that I've seen, like goref and GO_REF. As well, for the numbering, would a dash be preferred there, to match our old metadata?

E.g.: https://geneontology.org/gorefs/0000051.html or https://geneontology.org/gorefs/goref-0000051.html

pgaudet commented 5 months ago

Do we have a list of our PURLs somewhere? It would be good to standardize this. Right now the official prefix is "GO_REF:", I find it confusing to vary in different contexts.

kltm commented 5 months ago

https://github.com/OBOFoundry/purl.obolibrary.org/blob/master/config/go.yml

kltm commented 5 months ago

@pkalita-lbl Talking to @pgaudet here, this is the preference moving forward (although a little more work):

I believe that URLs resolve without the .html, so the "preferred" final right now would be, for example:

https://geneontology.org/GO_REF/0000051

(which may practically resolve to https://geneontology.org/GO_REF/0000051.html, depending).

I know that it may be a little quirky to have those in the top level, but I believe that works if you have an alternate URL in place? Having the /gorefs.html index would remain as-is; only the reference page, looking a bit like an object that closely matches the CURIE, would change.

I just tried looking at the plumbing right now, but was a little unsure if this was a reasonable ask. Let me know if it seems odd or fiddly and we can iterate on it. The main target is to get the individual pages looking as close to looking as close to the CURIE under our TLD as we reasonably can.

pkalita-lbl commented 5 months ago

I think that's reasonable. Or, at least, let's assume it is until I learn otherwise 😁

pkalita-lbl commented 5 months ago

The URL update is now complete via https://github.com/geneontology/geneontology.github.io/pull/534.

The URLs should resolve with or without a .html extension.

With that I assume we're now ready to work on updating the OBO PURLs to point to the new individual ref pages (https://github.com/geneontology/go-site/issues/2236)?

kltm commented 5 months ago

@pkalita-lbl Yes, I believe so. If the new pages are in play, we should just go ahead and updated--right now, they don't seem to be working so well, so there is nothing lost in moving forward.

kltm commented 5 months ago

@pgaudet (@pkalita-lbl) All items in this project are now closed. If there are any loose ends (release notes later, announcements, etc.), we can add tickets. Otherwise, this and the kanban board can be closed.