Skip to content

Consistent plan needed for Aliases #65

Open
@matthewtiscareno

Description

@matthewtiscareno

Checked for duplicates

Yes - I've already checked

🐛 Describe the bug

I am wondering what is expected with regard to aliases, which I interpret broadly as being alternate names of any kind whether they are acronyms or not.

For example, I notice that the Investigation spreadsheet includes both "HST" and "HUBBLE_SPACE_TELESCOPE" under alias_id for Hubble Space Telescope. However, the context product has Identification_Area/title = HST and Investigation/name = HST, and it also has Identification_Area/Alias_List/Alias/alternate_id = HUBBLE_SPACE_TELESCOPE and Identification_Area/Alias_List/Alias/alternate_title = HUBBLE SPACE TELESCOPE. Is the spreadsheet entry supposed to represent those things, even though it makes no distinction among them? Also, users might commonly use simply "Hubble" as an alternate name for this element, so should that name be included as an entry somewhere?

By similar token, the Instrument Host spreadsheet includes nothing under alias_id for Hubble Space Telescope, and the context product has Identification_Area/title = HUBBLE SPACE TELESCOPE and Instrument_Host/name = HUBBLE SPACE TELESCOPE but no instance of the class Identification_Area/Alias_List.

Possibly related, we noticed that in the beta search, searching on “hst” yields the Investigation (whose name is "HST") as the first result but does not yield the Instrument Host at all, while searching on “hubble” yields the Instrument Host (whose name is "HUBBLE SPACE TELESCOPE") as the first result but does not yield the Investigation at all (even stranger, if you click on the link it actually leads to the Investigation "Comet SL9 Collision into Jupiter"). Would these idiosyncrasies be fixed if we were to better configure the aliases?

🕵️ Expected behavior

I expect each common name for an element to be included as an entry in Alias.

📜 To Reproduce

...

🖥 Environment Info

  • Version of this software [e.g. vX.Y.Z]
  • Operating System: [e.g. MacOSX with Docker Desktop vX.Y]
    ...

📚 Version of Software Used

No response

🩺 Test Data / Additional context

No response

🦄 Related requirements

🦄 #xyz

Acceptance Criteria

Given
When I perform
Then I expect

⚙️ Engineering Details

No response

🎉 Integration & Test

No response

Metadata

Metadata

Assignees

Labels

Type

No type

Projects

Status

ToDo

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions