Add information about text search functionality to the data portal guide#346
Conversation
eecavanna
left a comment
There was a problem hiding this comment.
Thanks for writing this up. I'm going to suggest adding a comment to the relevant nmdc-server source code that reminds developers to update this document as that code changes.
| - `annotations` | ||
| - `alternate_identifiers` | ||
|
|
||
| The text search input can also accept NMDC identifiers. Searching by an identifier will find all studies and samples that are associated with that identifier. For example, this can be used to quickly find samples that are related to a specific study ID (e.g. `nmdc:sty-11-r2h77870`). Users can also use this to find samples that are associated with specific Data Object IDs, Omics Processing IDs, or Workflow IDs. |
There was a problem hiding this comment.
I thiiink the term "omics processing" has been replaced by something else in the schema (although it happens to still be used in the nmdc-server code base). Maybe "workflow execution"?
Hi @aclum, do you know what the modern, user-facing term is?
There was a problem hiding this comment.
The current schema class is Data Generation & Workflow Exeuction.
There was a problem hiding this comment.
Modifying to:
Users can also use this to find samples that are associated with specific Data Object IDs, Data Generation IDs, or Workflow Execution IDs.
|
Once the "omics processing" terminology thing has been resolved, you can merge this into |
aclum
left a comment
There was a problem hiding this comment.
Approve if suggested class name changes are made.
On this branch, I added a section to the Data Portal User Guide about how the new text search functionality works.
Details
The new text search behavior has some nuanced behavior that users may want to be aware of.
Related issue(s)
Fixes #345
See also PR in nmdc-server: microbiomedata/nmdc-server#2100
Impacted section(s)