sequencescape icon indicating copy to clipboard operation
sequencescape copied to clipboard

Y24-044 Remove 'asset' terminology

Open KatyTaylor opened this issue 10 months ago • 0 comments

Describe the Housekeeping The word 'asset' is used throughout Sequencescape and is confusing / non-intuitive as it refers to a historical concept in the product.

Task: Research an approach to remove the word asset from the product (apart from a few exceptions, noted below), and create stories to do so.

A couple of example approaches / stories I can think of:

  • By database vs code: Re-name all the foreign keys called asset_id on database tables at once (then do code references as a separate story).
  • By table / object: Take one database table that has a column called asset_id, and rename that column and any reference to it in the code (then repeat with other tables, one by one).

History: There used to be a table / model called Asset. Several years ago is was split into Labware (a piece of plastic used in the lab) and Receptacle (the hole(s) in that plastic that holds samples). In the database, there is a table called labware and a table called receptalces, but no table called assets. There is still a class called Asset, but it has minimal functionality. Wherever you find the word asset in the code, or as part of the name of a database table or column, it normally means receptacle; however, occasionally it means labware.

Exceptions: This is a exercise in re-naming terminology within Sequencescape. To prevent scope creep, I think we should leave the following alone for now:

  • Anything referring to Asset Audits - this is the name of another app, so references to this are OK
  • The actual class called Asset - this is re-naming, not modifying functionality, so leave the name of this class and any references to it along.

Additional context

This came out of a retrospective on 27/3/2024.

Data model:

Assets, Labware   Receptacles

KatyTaylor avatar Apr 02 '24 14:04 KatyTaylor