geneontology / project-management

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

Document and test devops documentation for GO services #85

Open kltm opened 6 months ago

kltm commented 6 months ago
Project link

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

Project description

TL;DR: Developers at all levels should be able to test code, put out new code releases, and update data using our documentation.

Over the last year, with the help of @abessiari, we have built up a set of DevOps tools and scripts to setup and service our major components, namely the GO API, the RDF endpoint, and AmiGO/GOlr.

This development work is wrapping soon (end of January) and we want to make sure that this new infrastructure is fully documented to meet the following criteria and use cases

(Note that we also should have functional Docker images for local development, but that may be outside the scope of these Terraform-related docs.)

Work done so far: @abessiari has done initial documentation; @sierra-moxon did a pass on GO API, getting it ready for production; @kltm and @dustine32 started a more generalized version of the documentation, but did not complete it.

Useful resources:

This documentation, out of necessity, may have to touch on topics like the release pipeline, credential distribution, DNS/Cloudflare, and the cert server.

PI

Chris

Product owner (PO)

Seth

Technical lead (TL)

Seth

Other personnel (OP)

Patrick, Sierra, Dustin

Technical specs

n/a

Other comments

I was going to originally file these items under #19, but thought that it would be more useful and understandable as it's own "project", rather than a set of tickets in an ongoing project.

kltm commented 6 months ago

@pgaudet This would be a mostly a @pkalita-lbl project, as we need to make progress before the end of January (while feedback can easily be given) and he is a good target for the docs; no other people would really need to be brought in, besides clarification of current documentation and test of said docs. I was going to originally slide this in under the "needful software" project, but thought it would be nice to have it surfaced on its own. I've talked to @cmungall about having @pkalita-lbl for this span and got thumbs up.

kltm commented 4 months ago

Given that we are punting the software get-together for the moment, where a major push to closing this would have taken place, and the fact that the iron is no longer particularly hot, @pgaudet given thumbs up to pecking away at this as is convenient.