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

updated fao_class description link #726

Open
wants to merge 6 commits into
base: main
Choose a base branch
from

Conversation

mslarae13
Copy link
Contributor

@mslarae13 mslarae13 commented Dec 8, 2023

Updated FaoClassEnum to match available list
Updated fao_class description to have updated link & reference for enum source

Updated FaoClassEnum to match available list
Copy link
Contributor

@cmungall cmungall left a comment

Choose a reason for hiding this comment

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

I don't know what the MIxS policy is on removing permissible values - these may have been used in existing projects.

I would instead mark these as deprecated; e.g

   Lithosols:
      deprecated: No longer in FAO as of YYYY-MM-DD / version X

@mslarae13 mslarae13 requested a review from cmungall June 24, 2024 23:16
Ferralsols:
Fluvisols:
Gleysols:
Greyzems:
deprecated: true, value no longer recognized by FAO, mixs/issues/696
Copy link
Member

Choose a reason for hiding this comment

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

I would prefer that the issue link is a real github url in a see also

Copy link
Contributor Author

@mslarae13 mslarae13 Jun 27, 2024

Choose a reason for hiding this comment

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

I am going to push back a bit on the "I would prefer" .. there's no standard structure for this process. I would prefer deprecated be a boolean or structured & there be a reason attribute so someone doesn't need to understand how see-also is a reason for deprecation. Because that's not intuitive to me. But, that's a LinkML limitation.
So how / who gets to say when someones preference is the action to take?

I am happy to change the issue path to the ACTUAL issue URL, seems long and like it's saying the same thing to me. But, excessive clarity makes sense.

@mslarae13

This comment was marked as resolved.

@mslarae13 mslarae13 requested a review from turbomam July 9, 2024 23:32
@mslarae13
Copy link
Contributor Author

To discuss at TWG:

deprecation protocol in place. However, policy should still be discussed & by that I mean I have tagged these to be deprecated but I'm not sure we've settled on WHEN things get removed from the mixs.yaml and put into the deprecated.yaml?

@lschriml
Copy link
Member

lschriml commented Jul 18, 2024 via email

@lschriml
Copy link
Member

lschriml commented Jul 18, 2024 via email

@turbomam
Copy link
Member

Good point @lschriml . @mslarae13 and Sierra have put together a good, tracable deprecation framework but I don' think we have something equivalent for traceable changes yet.

@turbomam
Copy link
Member

Or, specifically in this case, where do deprecated permissible values go? Other schema elements like classes and slots are eventually moved https://github.com/GenomicsStandardsConsortium/mixs/blob/main/src/mixs/schema/deprecated.yaml. Permissible values can't be moved (or searched) in a free standing manner

@lschriml
Copy link
Member

lschriml commented Jul 18, 2024 via email

@mslarae13
Copy link
Contributor Author

@lschriml

In the issue linked above. #696, and @only1chunts comment #696 (comment)

The FAO permissible values have changes & the previously provided link is no longer active. So I updated the enum to match the updated list of values. But yes, we can discuss

@lschriml
Copy link
Member

lschriml commented Jul 19, 2024 via email

@mslarae13
Copy link
Contributor Author

I don't know what the MIxS policy is on removing permissible values - these may have been used in existing projects.

I would instead mark these as deprecated; e.g

   Lithosols:
      deprecated: No longer in FAO as of YYYY-MM-DD / version X

Thanks @cmungall
Yes, we did implement the deprecated.yaml.

Based on the workflow proposed by Sierra and approved byt GSC and NMDC, the terms are marked for deprecation for 1 release. And after a release as marked for deprecation, the terms/items marked for deprecation are then moved into the deprecated.yaml.

As such, for this PR, the terms only get marked for deprecation.
Then, a version of MIxS will be released.
And then an separate PR will move these terms into deprecated.yaml.

Does this satisfy your request?

@mslarae13 mslarae13 self-assigned this Sep 3, 2024
@mslarae13 mslarae13 added the 1-TermUpdate Update suggestion for existing term, including bugs. Issues from "cig-bug" label moved here. label Sep 3, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
1-TermUpdate Update suggestion for existing term, including bugs. Issues from "cig-bug" label moved here.
Projects
Status: In Progress
Development

Successfully merging this pull request may close these issues.

fao_class description has link to a dead site
4 participants