Skip to content

Add information about text search functionality to the data portal guide#346

Merged
codytodonnell merged 4 commits into
mainfrom
345-add-information-about-text-search-functionality
Apr 29, 2026
Merged

Add information about text search functionality to the data portal guide#346
codytodonnell merged 4 commits into
mainfrom
345-add-information-about-text-search-functionality

Conversation

@codytodonnell

@codytodonnell codytodonnell commented Apr 22, 2026

Copy link
Copy Markdown
Contributor

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)

@eecavanna eecavanna left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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?

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The current schema class is Data Generation & Workflow Exeuction.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

@eecavanna

eecavanna commented Apr 22, 2026

Copy link
Copy Markdown
Collaborator

Once the "omics processing" terminology thing has been resolved, you can merge this into main; which will automatically deploy it to production (there is no "dev" instance of the docs site). (You can preview it locally using the instructions in this repo, at: https://github.com/microbiomedata/docs/blob/main/development.md)

@codytodonnell codytodonnell self-assigned this Apr 22, 2026

@aclum aclum left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Approve if suggested class name changes are made.

@codytodonnell codytodonnell merged commit 3a8c2b3 into main Apr 29, 2026
5 checks passed
@codytodonnell codytodonnell deleted the 345-add-information-about-text-search-functionality branch April 29, 2026 17:18
@github-project-automation github-project-automation Bot moved this from Backlog to Done in Documentation Squad Board Apr 29, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Development

Successfully merging this pull request may close these issues.

Add information about text search functionality

3 participants