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 deprecation protocol for GSC #805

Merged
merged 12 commits into from
Jul 9, 2024
Merged

Conversation

mslarae13
Copy link
Contributor

@mslarae13 mslarae13 commented Jun 18, 2024

Copying what Sierra Moxen did for NMDC to add deprecation protocol to the GSC.

@mslarae13 mslarae13 linked an issue Jun 18, 2024 that may be closed by this pull request
@mslarae13

This comment was marked as outdated.

sujaypatil96

This comment was marked as resolved.

@sujaypatil96

This comment was marked as outdated.

turbomam

This comment was marked as resolved.

add deprect to enum.md jinja
@mslarae13

This comment was marked as resolved.

remove part specific to NMDC
add enums to elements that can be deprecated
sujaypatil96

This comment was marked as resolved.

add deprecation needs
add id to deprecated
@mslarae13 mslarae13 marked this pull request as ready for review July 8, 2024 22:22
src/mixs/schema/deprecated.yaml Show resolved Hide resolved
src/doc-templates/class.md.jinja2 Outdated Show resolved Hide resolved
@mslarae13
Copy link
Contributor Author

@sujaypatil96

How can I update the GSC doc to have the deprecation info in the left like NMDC
Screenshot 2024-07-09 at 12 14 55 PM

MIxS
Screenshot 2024-07-09 at 12 14 59 PM

Should we put something here too? Probably not EXACTLY like NMDCs, since that's how to deprecate.. but (NOT for this PR), add something for how people can find / understand what deprecation means?

@sujaypatil96
Copy link
Collaborator

To include the deprecation guide as a webpage on the mixs docs website you will need to add a statement to the mkdocs.yml file in the mixs repo like how it has been added to the nmdc-schema repo: https://github.com/microbiomedata/nmdc-schema/blob/main/mkdocs.yml#L32

@mslarae13
Copy link
Contributor Author

mslarae13 commented Jul 9, 2024

To include the deprecation guide as a webpage on the mixs docs website you will need to add a statement to the mkdocs.yml file in the mixs repo like how it has been added to the nmdc-schema repo: https://github.com/microbiomedata/nmdc-schema/blob/main/mkdocs.yml#L32

@sujaypatil96 ok! I'll make an issue to do that as a separate PR

#819

@mslarae13
Copy link
Contributor Author

So this should be good to mereg, @sujaypatil96 ?

Copy link
Collaborator

@sujaypatil96 sujaypatil96 left a comment

Choose a reason for hiding this comment

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

Yup, this should be good to merge the way we have it now 🚀 Great work!!

@mslarae13 mslarae13 merged commit 5d2ca56 into main Jul 9, 2024
3 checks passed
@mslarae13 mslarae13 deleted the 804-add-gsc-deprecation-method branch July 9, 2024 23:09
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 GSC Deprecation method
3 participants