Decision: "Repotting" earthaccess to a new organization#1047
Decision: "Repotting" earthaccess to a new organization#1047
earthaccess to a new organization#1047Conversation
|
I will automatically update this comment whenever this PR is modified
|
3de24e9 to
aa28ee9
Compare
|
@mfisher87 I know we started this up collaboratively at the hackday a few weeks ago and wanted to check in: Were you planning to continue work on this, and/or hoping others can contribute to move this out of a draft state? let me know how I can help support. |
|
Glad you followed up, this fell off my radar. We need to convene some deciders and make the final review of this document and decide. I think we've recorded all of the alternatives. |
|
pre-commit.ci autofix |
Co-authored-by: Joseph H Kennedy <me@jhkennedy.org> Co-authored-by: danielfromearth <daniel.kaufman@nasa.gov> Co-authored-by: Amy Steiker <47193922+asteiker@users.noreply.github.com> Co-authored-by: Jessica Scheick <JessicaS11@users.noreply.github.com>
for more information, see https://pre-commit.ci
653d8e5 to
3fea1ff
Compare
Co-authored-by: Matt Fisher <mfisher87@gmail.com> Co-authored-by: Joseph H Kennedy <me@jhkennedy.org> Co-authored-by: danielfromearth <daniel.kaufman@nasa.gov> Co-authored-by: Jessica Scheick <JessicaS11@users.noreply.github.com> Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> Co-authored-by: asteiker <amy.steiker@gmail.com> Co-authored-by: Matt Fisher <3608264+mfisher87@users.noreply.github.com>
|
My vote is for option #2, repotting in a new organization. |
earthaccess to a new organization
earthaccess to a new organizationearthaccess to a new organization
jhkennedy
left a comment
There was a problem hiding this comment.
I vote for option 2, but I think there's a bit of work still to do to record the decision before I "approve".
| ### Option 2: Move to an independent org, e.g. `earthaccess-dev`. | ||
|
|
||
| Pros: | ||
| * Overall benefits described above |
There was a problem hiding this comment.
We should state these explicitly. Especially since the benefits might differ slightly between (2) and (3)
There was a problem hiding this comment.
Would you mind taking a pass at this?
There was a problem hiding this comment.
I'll try! Not sure when I'll get to it though...
| * Promoting NASA’s partnerships with other community members based on shared goals, by actively recognizing the critical contributions of those members and increasing transparency and trust. | ||
| * Meeting NASA Open Source Science goals. | ||
|
|
||
| Subsequent discussion included positive feedback from ESDIS on the value of earthaccess, and the desire to not disrupt the existing community development and engagement. An outcome of this meeting was to pursue a cross-DAAC proposal for sustained ESDIS funding, retaining the existing community ownership model while enhancing the communication of feature development across the earthaccess community and ESDIS. While inter-community support reduces ESDIS/NASA required support, we acknowledged in the proposal that increased ESDIS funding will also help us sustain the library. Although a proposal draft was developed, ESDIS asked for this effort to be paused in summer 2025. earthaccess is currently listed by ESDIS as an approved, operational Enterprise Solution, and was considered out of scope in broader tool and service convergence activities across other enterprise components. Regardless of the repository migration approach we choose, we will continue acknowledging ESDIS support through our ESDIS-funded contributors and the valuable facilitation role of NASA Openscapes. |
There was a problem hiding this comment.
An outcome of this meeting was to pursue a cross-DAAC proposal for sustained ESDIS funding, retaining the existing community ownership model while enhancing the communication of feature development across the earthaccess community and ESDIS. While inter-community support reduces ESDIS/NASA required support, we acknowledged in the proposal that increased ESDIS funding will also help us sustain the library. Although a proposal draft was developed, ESDIS asked for this effort to be paused in summer 2025. earthaccess is currently listed by ESDIS as an approved, operational Enterprise Solution, and was considered out of scope in broader tool and service convergence activities across other enterprise components. Regardless of the repository migration approach we choose, we will continue acknowledging ESDIS support through our ESDIS-funded contributors and the valuable facilitation role of NASA Openscapes.
All of this seems like an aside to me when reading through the doc. How does this effect the re-potting decision? What benifit does being an " approved, operational Enterprise Solution" give, and how does that relate to the re-potting decision? etc.
There was a problem hiding this comment.
Yeah, good call -- is there an upshot we can distill out of this that may be summarizable in 1 sentence @asteiker ?
There was a problem hiding this comment.
I believe we wanted some record of these events but at this point I agree that we don't need to couple this here. What if we simply retain the last sentence?
Co-authored-by: Joseph H Kennedy <me@jhkennedy.org>
|
pre-commit.ci autofix |
|
Calling for votes! @asteiker @betolink @chuckwondo @JessicaS11 @itcarroll @danielfromearth @Sherwin-14 |
|
Taking the current "cons" for option 2 at face value, I'll vote for 2. If additional "cons" are added by current members of the NSIDC org, my vote could change. So I'm not approving the PR at this time. @mfisher87 As you're shepherding this decision, do you have thoughts on how we establish the voting rules (i.e. quorum, majority or consensus, timing, etc ...)? Bummer we haven't advanced #1030. |
|
I'm okay with earthaccess-dev. |
Co-authored-by: Julia Stewart Lowndes <5891909+jules32@users.noreply.github.com>
|
Awesome, I think we're approaching a consensus! Thanks all. @jhkennedy @itcarroll what do you need to see to approve this PR? Would you submit a review with status "request changes" with some details so we can track it in the PR status? |
| * Promoting NASA’s partnerships with other community members based on shared goals, by actively recognizing the critical contributions of those members and increasing transparency and trust. | ||
| * Meeting NASA Open Source Science goals. | ||
|
|
||
| Subsequent discussion included positive feedback from ESDIS on the value of earthaccess, and the desire to not disrupt the existing community development and engagement. An outcome of this meeting was to pursue a cross-DAAC proposal for sustained ESDIS funding, retaining the existing community ownership model while enhancing the communication of feature development across the earthaccess community and ESDIS. While inter-community support reduces ESDIS/NASA required support, we acknowledged in the proposal that increased ESDIS funding will also help us sustain the library. Although a proposal draft was developed, ESDIS asked for this effort to be paused in summer 2025. earthaccess is currently listed by ESDIS as an approved, operational Enterprise Solution, and was considered out of scope in broader tool and service convergence activities across other enterprise components. Regardless of the repository migration approach we choose, we will continue acknowledging ESDIS support through our ESDIS-funded contributors and the valuable facilitation role of NASA Openscapes. |
There was a problem hiding this comment.
I believe we wanted some record of these events but at this point I agree that we don't need to couple this here. What if we simply retain the last sentence?
|
|
||
| 1. Local Clones: | ||
| * According to GitHub [Transferring a repository](https://docs.github.com/en/repositories/creating-and-managing-repositories/transferring-a-repository#whats-transferred-with-a-repository) documentation, "All links to the previous repository location are automatically redirected to the new location. When you use git clone, git fetch, or git push on a transferred repository, these commands will redirect to the new repository location or URL. However, to avoid confusion, we strongly recommend updating any existing local clones to point to the new repository URL. You can do this by using git remote on the command line: `git remote set-url origin NEW_URL` | ||
| * We will create an "explanation" page in our docs as a historical record and include instructions for updating local clones. |
There was a problem hiding this comment.
So, is this the decision record? Or a new docs page? Should we do this as part of this PR?
There was a problem hiding this comment.
Hmmm. Should instructions for updating local clones be on the top-level README.md, at least for a little while (say, a few months or so)?
There was a problem hiding this comment.
@jhkennedy you are reminding me that I need to revisit #1030 ! Outside of that though, I have also been wondering about our overall communication plan to ensure that users know about the move. I don't think we need to describe that here but it is something we should coordinate together. Pulling out a few other relevant notes from our last hackday regarding communication and overall action plan:
- Need to add Issues based on the maintenance effort listed in the decision doc.
- @mfisher87 thoughts on creating a main repotting Issue with sub-issues to capture each of the user documentation and admin tasks?
- Propose new release for the readthedocs updates mentioned in the decision doc, so stable reflects the updates (local clone guidance, contributor updates).
- Again @mfisher87, thoughts on this? If we update the top-level README.md as Danny suggests, maybe this isn't as critical?
There was a problem hiding this comment.
So, is this the decision record? Or a new docs page? Should we do this as part of this PR?
I think we should create a new docs page for this. E.g. "Explanation - We moved the repository out of the NSIDC org"
Hmmm. Should instructions for updating local clones be on the top-level README.md, at least for a little while (say, a few months or so)?
That seems sensible to me! Let's put it on the checklist in the "Decision" section at the end of the document.
There was a problem hiding this comment.
I have also been wondering about our overall communication plan to ensure that users know about the move. I don't think we need to describe that here but it is something we should coordinate together.
I do think that should be part of our checklist at the end of the doc.
thoughts on creating a main repotting Issue with sub-issues to capture each of the user documentation and admin tasks
Love this idea :) Maybe instead of embedding the checklist in the decision doc we just link to this issue.
Propose new release for the readthedocs updates mentioned in the decision doc, so stable reflects the updates (local clone guidance, contributor updates).
- Again @mfisher87, thoughts on this? If we update the top-level README.md as Danny suggests, maybe this isn't as critical?
This is something that frustrates me a bit -- stable docs releases are coupled to software releases. I think updating the top-level README / contributing doc is a good way to ensure this information is prominent without having to do a software release in service of the docs.
There was a problem hiding this comment.
This is something that frustrates me a bit -- stable docs releases are coupled to software releases. I think updating the top-level README / contributing doc is a good way to ensure this information is prominent without having to do a software release in service of the docs.
This is only because we've bundled docs into this single repo. With earthaccess-dev, we could have docs in an earthaccess-docs repo, and autodoc the latest stable version of earthaccess. The benefit is that it decouples doc updates from software releases, but at the cost of things potentially getting out of sync, as there are two places to update. Though, really, I don't see a problem with just releasing earthaccess more rapidly if if it's just docs-only releases -- just comes down to preference.
But being able to decouple docs from the package is a potential benefit for repotting, since we can't do so easily right now.
There was a problem hiding this comment.
Interesting idea. I hadn't thought of that approach before!
Though, really, I don't see a problem with just releasing earthaccess more rapidly if if it's just docs-only releases -- just comes down to preference.
My concern is that with semantic versioning, version numbers have meaning, so doing releases just for docs changes is (for me 🙃) confusing under that system of meaning!
There was a problem hiding this comment.
My concern is that with semantic versioning, version numbers have meaning, , so doing releases just for docs changes is (for me 🙃) confusing under that system of meaning!
This is all an aside, but I mean, that's why PEP-440 supports .postN releases -- I like the dev and post extensions of PEP-440 over strict SemVer numbering. You still get the SemVer meaning with the vX.Y.Z, but can also do post releases for things like docs and what not, and can let hatch-vcs and similar provide good development release versions without ever having to hard-code a version number.
There was a problem hiding this comment.
I guess so! Maybe now I'm moving the goalposts, but there are still two things I'm uncomfortable with: (1) who might be confused about this; (2) the unnecessary data storage involved with publishing more packages just to update the docs. But yeah, let's punt on this and keep discussing in a different venue :)
|
Have been out sick, but wanted note my agreeing vote for option 2! |
|
It's wonderful to see this strong consensus :) |
|
Been extremely busy the last couple of months. But I made sure to find time today to cast my vote for Option 2. Better late than never! |
|
Thanks @Sherwin-14 ! Good to see you again 😁 |
|
I added a checklist. What did I miss? |
Co-authored-by: Ian Carroll <ian.t.carroll@nasa.gov>
This decision record is about "repotting" (transferring) earthaccess to a new organization. See the decision record in the diff for motivation, considerations, and options.
Votes:
earthaccess-devearthaccess-devearthaccess-devearthaccess-devearthaccess-dev, but offers other options)earthaccess-devearthaccess-devPull Request (PR) draft checklist - click to expand
contributing documentation
before getting started.
title such as "Add testing details to the contributor section of the README".
Example PRs: #763
example
closes #1. SeeGitHub docs - Linking a pull request to an issue.
CHANGELOG.mdwith details about your change in a section titled## Unreleased. If such a section does not exist, please create one. FollowCommon Changelog for your additions.
Example PRs: #763
README.mdwith details of changes to theearthaccess interface, if any. Consider new environment variables, function names,
decorators, etc.
Click the "Ready for review" button at the bottom of the "Conversation" tab in GitHub
once these requirements are fulfilled. Don't worry if you see any test failures in
GitHub at this point!
Pull Request (PR) merge checklist - click to expand
Please do your best to complete these requirements! If you need help with any of these
requirements, you can ping the
@nsidc/earthaccess-supportteam in a comment and wewill help you out!
Request containing "pre-commit.ci autofix" to automate this.
📚 Documentation preview 📚: https://earthaccess--1047.org.readthedocs.build/en/1047/