sanger / traction Goto Github PK

User story
As PSD we need to understand how the Limber XP tube barcode reference will be passed through into Traction and be accessible on the run. This reference will let the user connect the run to the mBrave file generated from the XP tube sample metadata.

Who are the primary contacts for this story
PSD

Who is the nominated tester for UAT
PSD

Acceptance criteria
To be considered successful the solution must allow:

• understand how the source tube barcode will be passed through the export process into Limber and how it can be displayed to the user at the run stage in Traction
• write up any required stories

Dependencies
This story is blocked by the following dependencies:

• None

References
This story has a non-blocking relationship with:

• DPL-662, 663, and 666

Additional context
The Limber tube being exported to Traction may contain up to 9216 samples. We only need 1 sample for Traction as de-plexing is done via mBrave software later. The export message should include the XP tube barcode (and maybe UUID). In Traction that 'source' can possibly be stored in the traction object(s) created there, so that it is accessible when we display the run rows. The user can then relate that source barcode to the mBrave file that should have been created when the Limber export into Traction was performed (the filename could include the barcode).

User story
Add bioscan-specific version of PacBio runs screen - with button to 'Generate mBrave file'. This may need to be asynchronus with state e.g. 'pending' / 'ready' and button changing to 'download' when ready.

Who are the primary contacts for this story
Andrew
Steve
Harriet

Who is the nominated tester for UAT
?

Acceptance criteria
To be considered successful the solution must allow:

• Create a mock up of this page
• Create a page (Q: where?) for Bioscan runs only
• Distinguish Bioscan runs from other Pacbio runs (Q: how?)
• Show a table with only Bioscan runs on the page
• For each run, add a button 'Generate mBrave file'
• This button will call SS, passing in the "source" of the runs, pool/ sample. This call will be asyn
• Handle the state of the asyn call, with "Pending" shown, when the request to SS is in progress. When the request is completed, change the state to 'ready'
• When the state is ready, allow the use to download the mBrave file

Dependencies
This story is blocked by the following dependencies:

• #<issue_no.>
• sanger/#<issue_no.>

References
This story has a non-blocking relationship with:

• #<issue_no.>
• sanger/#<issue_no.>

Additional context
Add any other context or screenshots about the feature request here.

Bioscan Lucid here

User story
If we have external users we will need to make sure we are careful to adhere to sem-ver. Breaking changes to consider are anything that may break:

1. Interactions with upstream receptions (even including things like Sequencescape)
2. Interactions with downstream APIs.

We'll need to consider policies on backwards compatibility when updates to vendor software are breaking. ie. Do we just bump version numbers ourselves, or maintain compatibility with earlier versions. A clear policy here would build confidence.

Who are the primary contacts for this story
e.g. John S (don't include surnames in public repos)

Acceptance criteria
To be considered successful the solution must allow:

• add a list of acceptance criteria here
• ...

Dependencies
This story is blocked by the following dependencies:

• #<issue_no.>
• sanger/#<issue_no.>

References
This story has a non-blocking relationship with:

• #<issue_no.>
• sanger/#<issue_no.>

Additional context
Add any other context or screenshots about the feature request here.

User story
The clear and concise user story describing what is required. e.g. As an SSR user I would like sample manifests to allow me to upload x ...

Who are the primary contacts for this story
e.g. John S (don't include surnames in public repos)

Acceptance criteria
To be considered successful the solution must allow:

• add a list of acceptance criteria here
• ...

Dependencies
This story is blocked by the following dependencies:

• #<issue_no.>
• sanger/#<issue_no.>

References
This story has a non-blocking relationship with:

• #<issue_no.>
• sanger/#<issue_no.>

Additional context
Add any other context or screenshots about the feature request here.

User story
The clear and concise user story describing what is required. e.g. As an SSR user I would like sample manifests to allow me to upload x ...

Who are the primary contacts for this story
e.g. John S (don't include surnames in public repos)

Acceptance criteria
To be considered successful the solution must allow:

• add a list of acceptance criteria here
• ...

Dependencies
This story is blocked by the following dependencies:

• #<issue_no.>
• sanger/#<issue_no.>

References
This story has a non-blocking relationship with:

• #<issue_no.>
• sanger/#<issue_no.>

Additional context
Add any other context or screenshots about the feature request here.

User story
The clear and concise user story describing what is required. e.g. As an SSR user I would like sample manifests to allow me to upload x ...

Who are the primary contacts for this story
e.g. John S (don't include surnames in public repos)

Acceptance criteria
To be considered successful the solution must allow:

• add a list of acceptance criteria here
• ...

Dependencies
This story is blocked by the following dependencies:

• #<issue_no.>
• sanger/#<issue_no.>

References
This story has a non-blocking relationship with:

• #<issue_no.>
• sanger/#<issue_no.>

Additional context
Add any other context or screenshots about the feature request here.

User story
Evaluate the use of typescript to improve code robustness and self-documentation. Will assist with encouraging external collaberators.

Who are the primary contacts for this story
e.g. John S (don't include surnames in public repos)

Acceptance criteria
To be considered successful the solution must allow:

• add a list of acceptance criteria here
• ...

Dependencies
This story is blocked by the following dependencies:

• #<issue_no.>
• sanger/#<issue_no.>

References
This story has a non-blocking relationship with:

• #<issue_no.>
• sanger/#<issue_no.>

Additional context
Add any other context or screenshots about the feature request here.

User story

• vuex
• pinia

We're currently using vuex, however it may be worth considering pinia in future.

Who are the primary contacts for this story
e.g. John S (don't include surnames in public repos)

Acceptance criteria
To be considered successful the solution must allow:

• add a list of acceptance criteria here
• ...

Dependencies
This story is blocked by the following dependencies:

• #<issue_no.>
• sanger/#<issue_no.>

References
This story has a non-blocking relationship with:

• #<issue_no.>
• sanger/#<issue_no.>

Additional context
Add any other context or screenshots about the feature request here.

User story
Ensure the application is tested for security and dependency updates

Who are the primary contacts for this story
e.g. John S (don't include surnames in public repos)

Acceptance criteria
To be considered successful the solution must allow:

• add a list of acceptance criteria here
• ...

Dependencies
This story is blocked by the following dependencies:

• #<issue_no.>
• sanger/#<issue_no.>

References
This story has a non-blocking relationship with:

• #<issue_no.>
• sanger/#<issue_no.>

Additional context
Add any other context or screenshots about the feature request here.

User story
The clear and concise user story describing what is required. e.g. As an SSR user I would like sample manifests to allow me to upload x ...

Who are the primary contacts for this story
e.g. John S (don't include surnames in public repos)

Acceptance criteria
To be considered successful the solution must allow:

• add a list of acceptance criteria here
• ...

Dependencies
This story is blocked by the following dependencies:

• #<issue_no.>
• sanger/#<issue_no.>

References
This story has a non-blocking relationship with:

• #<issue_no.>
• sanger/#<issue_no.>

Additional context
Add any other context or screenshots about the feature request here.

User story
The clear and concise user story describing what is required. e.g. As an SSR user I would like sample manifests to allow me to upload x ...

Who are the primary contacts for this story
e.g. John S (don't include surnames in public repos)

Acceptance criteria
To be considered successful the solution must allow:

• add a list of acceptance criteria here
• ...

Dependencies
This story is blocked by the following dependencies:

• #<issue_no.>
• sanger/#<issue_no.>

References
This story has a non-blocking relationship with:

• #<issue_no.>
• sanger/#<issue_no.>

Additional context
Add any other context or screenshots about the feature request here.

User story

• logins (eg. pointing at ldap, OAuth?)
• api keys

Who are the primary contacts for this story
e.g. John S (don't include surnames in public repos)

Acceptance criteria
To be considered successful the solution must allow:

• add a list of acceptance criteria here
• ...

Dependencies
This story is blocked by the following dependencies:

• #<issue_no.>
• sanger/#<issue_no.>

References
This story has a non-blocking relationship with:

• #<issue_no.>
• sanger/#<issue_no.>

Additional context
Add any other context or screenshots about the feature request here.

User story
The clear and concise user story describing what is required. e.g. As an SSR user I would like sample manifests to allow me to upload x ...

https://12factor.net worth considering for configuration, rather than JSON for config that doesn't need to change on the fly.

Who are the primary contacts for this story
e.g. John S (don't include surnames in public repos)

Acceptance criteria
To be considered successful the solution must allow:

• add a list of acceptance criteria here
• ...

Dependencies
This story is blocked by the following dependencies:

• #<issue_no.>
• sanger/#<issue_no.>

References
This story has a non-blocking relationship with:

• #<issue_no.>
• sanger/#<issue_no.>

Additional context
Add any other context or screenshots about the feature request here.

User story
The clear and concise user story describing what is required. e.g. As an SSR user I would like sample manifests to allow me to upload x ...

Who are the primary contacts for this story
e.g. John S (don't include surnames in public repos)

Acceptance criteria
To be considered successful the solution must allow:

• add a list of acceptance criteria here
• ...

Dependencies
This story is blocked by the following dependencies:

• #<issue_no.>
• sanger/#<issue_no.>

References
This story has a non-blocking relationship with:

• #<issue_no.>
• sanger/#<issue_no.>

Additional context
Add any other context or screenshots about the feature request here.

User story

• pacbio api
• ONT api

Who are the primary contacts for this story
e.g. John S (don't include surnames in public repos)

Acceptance criteria
To be considered successful the solution must allow:

• add a list of acceptance criteria here
• ...

Dependencies
This story is blocked by the following dependencies:

• #<issue_no.>
• sanger/#<issue_no.>

References
This story has a non-blocking relationship with:

• #<issue_no.>
• sanger/#<issue_no.>

Additional context
Add any other context or screenshots about the feature request here.

User story
The clear and concise user story describing what is required. e.g. As an SSR user I would like sample manifests to allow me to upload x ...

Who are the primary contacts for this story
e.g. John S (don't include surnames in public repos)

Acceptance criteria
To be considered successful the solution must allow:

• add a list of acceptance criteria here
• ...

Dependencies
This story is blocked by the following dependencies:

• #<issue_no.>
• sanger/#<issue_no.>

References
This story has a non-blocking relationship with:

• #<issue_no.>
• sanger/#<issue_no.>

Additional context
Add any other context or screenshots about the feature request here.

User story
The clear and concise user story describing what is required. e.g. As an SSR user I would like sample manifests to allow me to upload x ...

Who are the primary contacts for this story
e.g. John S (don't include surnames in public repos)

Acceptance criteria
To be considered successful the solution must allow:

• add a list of acceptance criteria here
• ...

Dependencies
This story is blocked by the following dependencies:

• #<issue_no.>
• sanger/#<issue_no.>

References
This story has a non-blocking relationship with:

• #<issue_no.>
• sanger/#<issue_no.>

Additional context
Add any other context or screenshots about the feature request here.

User story
The clear and concise user story describing what is required. e.g. As an SSR user I would like sample manifests to allow me to upload x ...

Who are the primary contacts for this story
e.g. John S (don't include surnames in public repos)

Acceptance criteria
To be considered successful the solution must allow:

• add a list of acceptance criteria here
• ...

Dependencies
This story is blocked by the following dependencies:

• #<issue_no.>
• sanger/#<issue_no.>

References
This story has a non-blocking relationship with:

• #<issue_no.>
• sanger/#<issue_no.>

Additional context
Add any other context or screenshots about the feature request here.

User story
documentation

• read me
• setup
• troubleshooting
• developer documentation for ui jsDoc
• developer documentation for service Yard
• Hosting as github pages?

Who are the primary contacts for this story
e.g. John S (don't include surnames in public repos)

Acceptance criteria
To be considered successful the solution must allow:

• add a list of acceptance criteria here
• ...

Dependencies
This story is blocked by the following dependencies:

• #<issue_no.>
• sanger/#<issue_no.>

References
This story has a non-blocking relationship with:

• #<issue_no.>
• sanger/#<issue_no.>

Additional context
Add any other context or screenshots about the feature request here.

User story

As a developer I would like strong integration tests to check the interaction between traction-service and traction-ui. This will become substantially easier once they are in a monorepo.

Integration with external services should also be considered, but we should avoid requiring Sequencescape or other external dependencies for default runs.

Who are the primary contacts for this story
e.g. John S (don't include surnames in public repos)

Acceptance criteria
To be considered successful the solution must allow:

• add a list of acceptance criteria here
• ...

Dependencies
This story is blocked by the following dependencies:

• #<issue_no.>
• sanger/#<issue_no.>

References
This story has a non-blocking relationship with:

• #<issue_no.>
• sanger/#<issue_no.>

Additional context
Add any other context or screenshots about the feature request here.

User story

• use a screen reader

Who are the primary contacts for this story
e.g. John S (don't include surnames in public repos)

Acceptance criteria
To be considered successful the solution must allow:

• add a list of acceptance criteria here
• ...

Dependencies
This story is blocked by the following dependencies:

• #<issue_no.>
• sanger/#<issue_no.>

References
This story has a non-blocking relationship with:

• #<issue_no.>
• sanger/#<issue_no.>

Additional context
Add any other context or screenshots about the feature request here.

User story
The clear and concise user story describing what is required. e.g. As an SSR user I would like sample manifests to allow me to upload x ...

Who are the primary contacts for this story
e.g. John S (don't include surnames in public repos)

Acceptance criteria
To be considered successful the solution must allow:

• add a list of acceptance criteria here
• ...

Dependencies
This story is blocked by the following dependencies:

• #<issue_no.>
• sanger/#<issue_no.>

References
This story has a non-blocking relationship with:

• #<issue_no.>
• sanger/#<issue_no.>

Additional context
Add any other context or screenshots about the feature request here.

User story
Make it more professional looking using tailwind and the styling from STAN

Who are the primary contacts for this story
e.g. John S (don't include surnames in public repos)

Acceptance criteria
To be considered successful the solution must allow:

• add a list of acceptance criteria here
• ...

Dependencies
This story is blocked by the following dependencies:

• #<issue_no.>
• sanger/#<issue_no.>

References
This story has a non-blocking relationship with:

• #<issue_no.>
• sanger/#<issue_no.>

Additional context
Add any other context or screenshots about the feature request here.

User story
Migrate from Vue-cli to vite.

Who are the primary contacts for this story
e.g. John S (don't include surnames in public repos)

Acceptance criteria
To be considered successful the solution must allow:

• add a list of acceptance criteria here
• ...

Dependencies
This story is blocked by the following dependencies:

• #<issue_no.>
• sanger/#<issue_no.>

References
This story has a non-blocking relationship with:

• #<issue_no.>
• sanger/#<issue_no.>

Additional context
Add any other context or screenshots about the feature request here.

User story
End users should be able to configure the database to point to an externally managed solution, possibly considering a range of database platforms (eg. MySQL, Postgress, SQLlite)

Consider setup for teams without dedicated DBA teams. Will need to make sure that the database ends up on a stable volume.

Who are the primary contacts for this story
e.g. John S (don't include surnames in public repos)

Acceptance criteria
To be considered successful the solution must allow:

• add a list of acceptance criteria here
• ...

Dependencies
This story is blocked by the following dependencies:

• #<issue_no.>
• sanger/#<issue_no.>

References
This story has a non-blocking relationship with:

• #<issue_no.>
• sanger/#<issue_no.>

Additional context
Add any other context or screenshots about the feature request here.

User story
The clear and concise user story describing what is required. e.g. As an SSR user I would like sample manifests to allow me to upload x ...

Who are the primary contacts for this story
e.g. John S (don't include surnames in public repos)

Acceptance criteria
To be considered successful the solution must allow:

• add a list of acceptance criteria here
• ...

Dependencies
This story is blocked by the following dependencies:

• #<issue_no.>
• sanger/#<issue_no.>

References
This story has a non-blocking relationship with:

• #<issue_no.>
• sanger/#<issue_no.>

Additional context
Add any other context or screenshots about the feature request here.