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

Docs for backwards compatibility #763

Merged
merged 15 commits into from
Sep 17, 2024
Merged

Conversation

Sherwin-14
Copy link
Contributor

@Sherwin-14 Sherwin-14 commented Jul 12, 2024

Added the docs for backwards compatibility as per the issue descriptions. "resolves #471".


📚 Documentation preview 📚: https://earthaccess--763.org.readthedocs.build/en/763/

@Sherwin-14 Sherwin-14 marked this pull request as draft July 12, 2024 17:20
@Sherwin-14 Sherwin-14 marked this pull request as ready for review July 12, 2024 17:27
@mfisher87
Copy link
Collaborator

Would you be able to rebase or cherry-pick to remove the merge commits from the PR? I'd be happy to help out with that as well!

This PR is aimed at solving the issue no `closes nsidc#471`
Copy link
Collaborator

@mfisher87 mfisher87 left a comment

Choose a reason for hiding this comment

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

Awesome work! I think we need a little more feedback from around the group, so I'll tag to discuss at a hack day! 🙇

docs/user_guide/backwards-compatibility.md Outdated Show resolved Hide resolved
docs/user_guide/backwards-compatibility.md Outdated Show resolved Hide resolved
docs/user_guide/backwards-compatibility.md Outdated Show resolved Hide resolved
docs/user_guide/backwards-compatibility.md Outdated Show resolved Hide resolved
docs/user_guide/backwards-compatibility.md Outdated Show resolved Hide resolved
docs/user_guide/backwards-compatibility.md Outdated Show resolved Hide resolved
docs/user_guide/backwards-compatibility.md Outdated Show resolved Hide resolved
docs/user_guide/backwards-compatibility.md Outdated Show resolved Hide resolved
docs/user_guide/backwards-compatibility.md Outdated Show resolved Hide resolved
docs/user_guide/backwards-compatibility.md Outdated Show resolved Hide resolved
@mfisher87 mfisher87 added the hackathon An issue we'd like to visit during a hackathon event label Jul 15, 2024
@mfisher87 mfisher87 requested a review from asteiker July 15, 2024 02:02
@mfisher87
Copy link
Collaborator

mfisher87 commented Jul 15, 2024

Oh, right, let's get SPEC0 in there :) I think (but don't assume) we have a consensus that's what we want to do. Let's find out! :)

@mfisher87
Copy link
Collaborator

A couple minor TODOs left here @Sherwin-14, do you have time to take care of them, or would it be OK for a maintainer to finish this off?

@Sherwin-14
Copy link
Contributor Author

Yeah I just finished some important assignments so I can take care of this now but what changes do we need to accomodate?

@mfisher87
Copy link
Collaborator

I think two TODOs left: adding a link to our API documentation (user-reference/api/api); and adding a reference to SPEC0 as our dependency deprecation policy.

No rush, and also we're happy to pick up the finishing touches if your schedule is too busy for now. Just let us know!

@Sherwin-14
Copy link
Contributor Author

I think two TODOs left: adding a link to our API documentation (user-reference/api/api); and adding a reference to SPEC0 as our dependency deprecation policy.

No rush, and also we're happy to pick up the finishing touches if your schedule is too busy for now. Just let us know!

I'll do both of them. But which section are we going to refer the SPEC0 policy, do we need to assign an entirely different section for this?

@mfisher87
Copy link
Collaborator

I think a new section for SPEC0 makes sense. For example, "Our Python and dependency support policy"

@Sherwin-14
Copy link
Contributor Author

Apologies, I'm just now noticing that there's no navigation link to this page yet (https://earthaccess--763.org.readthedocs.build/en/763/)!

Can you update mkdocs.yml accordingly? Don't forget to double check the preview :)

bc
Have we decided the channel where we would announce our releases?

@mfisher87
Copy link
Collaborator

mfisher87 commented Sep 17, 2024

For now, let's just use GitHub Releases as our only announcement channel. We may later have a newsletter or blog that we'll use, but for now we don't have those things. The #earthaccess channel in the Openscapes is semi-private (you have to ask to join, but we're just approving everyone who asks), so I don't think it should be listed.

This is looking really good, and I'm excited to merge! Can you @ me or re-request a review from me as soon as you have that final touch applied?

@mfisher87
Copy link
Collaborator

Amazing work, thank you!

@mfisher87 mfisher87 merged commit bb553e1 into nsidc:main Sep 17, 2024
7 of 11 checks passed
@jhkennedy jhkennedy mentioned this pull request Sep 21, 2024
10 tasks
@mfisher87 mfisher87 linked an issue Oct 2, 2024 that may be closed by this pull request
@ebolch ebolch mentioned this pull request Oct 31, 2024
9 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
hackathon An issue we'd like to visit during a hackathon event
Projects
None yet
2 participants