Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add tooltip annotation for gold_path_field #2120

Merged

Conversation

aclum
Copy link
Contributor

@aclum aclum commented Jul 12, 2024

This PR adds a tool tip for slot gold_path_field. Description change only, no changes to example data. No migration needed.

Copy link

github-actions bot commented Jul 12, 2024

PR Preview Action v1.4.7
🚀 Deployed preview to https://microbiomedata.github.io/nmdc-schema/pr-preview/pr-2120/
on branch gh-pages at 2024-07-16 20:11 UTC

@turbomam
Copy link
Member

@aclum can you say where you got that definition?

You wanted me to do something similar for the MIxS environmental triad as a group, right?

src/schema/nmdc.yaml Outdated Show resolved Hide resolved
@aclum
Copy link
Contributor Author

aclum commented Jul 15, 2024

@turbomam that description came from https://gold.jgi.doe.gov/ecosystem_classification, should i add that as comment?

Added linkml comments and made tool tip a single line.
@aclum aclum requested a review from turbomam July 15, 2024 21:15
@aclum
Copy link
Contributor Author

aclum commented Jul 16, 2024

@turbomam okay to merge this in? This was tentatively approved by the refactor folks yesterday.

@turbomam
Copy link
Member

turbomam commented Jul 16, 2024

I was hoping we could put the comment on the annotation itself. But that would require the use of a wordier collection form
and a nested annotation!

    annotations:
      tool_tip:
        tag: tool_tip
        value: GOLD Ecosystem Classification paths describe the surroundings from which an environmental sample or an organism is collected.
        annotations:
          source: https://gold.jgi.doe.gov/ecosystem_classification

I will approve now. We can use either what I suggested above or what you already have.

@aclum
Copy link
Contributor Author

aclum commented Jul 16, 2024

I don't have a preference, I just didn't have an example to work off of. I'll update to this format now.

@aclum aclum requested a review from turbomam July 16, 2024 20:14
@aclum
Copy link
Contributor Author

aclum commented Jul 16, 2024

@turbomam updated the modeling to your preferred syntax.

@aclum aclum merged commit d5b6cbe into main Jul 17, 2024
3 checks passed
@aclum aclum deleted the 682-add-gold-definition-to-data-portal-left-panel-search-bar branch July 17, 2024 20:06
@@ -2968,6 +2968,12 @@ slots:
abstract: true
description: >-
This is a grouping for any of the gold path fields
annotations:
tool_tip:
Copy link
Collaborator

Choose a reason for hiding this comment

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

I don't think I've come across this spelling of "tooltip" before. I don't meant to say it's incorrect, just that I think I've only ever seen it spelled as a single word.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add "GOLD" definition to Data Portal left panel search bar
4 participants