Widget Alignment and Documentation

[kltm]

Project link

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

Project description

The purpose of this project is to:

• align the pathways widget version in use across the GO (i.e. noctua, amigo, alliance)
• make sure that fixes and rollout can be done by any developer
• move noctua to a versioned pathway widget
• fully document the process from the POV of 1) an end user and 2) GO developers.

We would like to do this for the pathway widget (first focus) and ribbon.

Scope/Deliverables

• Bring all GO-authored web components into a uniform development and release process
• Deploy the most recent version of the Pathway Widget to all internal instances: AmiGO, Noctua (others?)
• Document the functioning and installation of the widget for 'external users'
• Set up a communication system to announce modifications (GH repo 'GO technical announcements')
• Get a list of all known users of the widget and register them to 'GO technical announcements'

Motivations

• Curators
  • Data will look more uniform across various implementations
• Data consumers
  • Internal and external uses of the Pathway widget will be able to use the same version
  • New users will have clear documentation
  • Users will be notified of any changes in widget version
• Optimizing use of internal resources
• Current grant aim
• Positioning for next grant
  • Solid Pathway widget that can be used to disseminate GO-CAMs

Coordination (with other resources)

• List all impacted groups
  • UniProt, Alliance, FlyBase, PomBase. Others?
• Get a formal approval from groups before starting the project

Tasks

TBD

Dependencies

TBD

Cost/Resources

TBD

Strengths/Opportunities

TBD

Weaknesses/Threats

TBD

Risks/Mitigations

TBD

Fail state/Withdrawal

TBD

Technical specs

TBD (template: https://docs.google.com/document/d/111UqtS3G0aJZpAijZYI3Da0t94OQpGePlPJsqZE4Tio/edit)

Personnel

PI: Chris; PO: Pascale; TL: Patrick; Other: Tremayne, Seth

Other comments

N/A