How we do (or do not) utilize Tutorials has been a point of conversation for earthaccess many times. See the following issues, and a new PR, that makes it evident we should discuss this and try to reach consensus:
Through conversations, I have come up with a prospective path forward that we can use to start the discussion:
We keep the "Tutorials" section of our docs in the User Guide, but we change the scope. We ONLY fully host/ maintain tutorials that are explicitly earthaccess functionality focused.
There are tons of great tutorials out there that utilize earthaccess but then move on to other scientific inquiries/ tasks. It is great that the library is being used, but those other scientific tasks are not the core functions of the library, and its functions are usually only one small subset of the work being done. Instead of us hosting that sort of tutorial content, we can feature it in some way (imagine a link in the nav much like we have now, but when you click on it, instead of a full-blown tutorial, you have a brief paragraph explaining the cool things the tutorial does and then a link to where that tutorial is hosted).
I see a lot of benefits to this approach... it reduces work duplication (with all the various cookbooks out there, DAACS doing different things, etc.), it reduces our maintainer burden (we just check that the tutorial is still there and that it works once in a while and take it down if it doesn't and there are no plans for its maintainers to fix it), and it allows external folks to potentially have their cookbook/ repo featured without having to maintain the tutorial in multiple places.
There is currently a new PR (#1398) that would add some Tutorial content (awesome that folks want to contribute!!), but we need to sort out how to best feature/ host this type of content.
I have tagged some people here that I think will be interested in this, but any and all feel free to chime in!
@andypbarrett @mfisher87 @asteiker @JessicaS11 @betolink
How we do (or do not) utilize Tutorials has been a point of conversation for
earthaccessmany times. See the following issues, and a new PR, that makes it evident we should discuss this and try to reach consensus:Through conversations, I have come up with a prospective path forward that we can use to start the discussion:
We keep the "Tutorials" section of our docs in the User Guide, but we change the scope. We ONLY fully host/ maintain tutorials that are explicitly
earthaccessfunctionality focused.There are tons of great tutorials out there that utilize
earthaccessbut then move on to other scientific inquiries/ tasks. It is great that the library is being used, but those other scientific tasks are not the core functions of the library, and its functions are usually only one small subset of the work being done. Instead of us hosting that sort of tutorial content, we can feature it in some way (imagine a link in the nav much like we have now, but when you click on it, instead of a full-blown tutorial, you have a brief paragraph explaining the cool things the tutorial does and then a link to where that tutorial is hosted).I see a lot of benefits to this approach... it reduces work duplication (with all the various cookbooks out there, DAACS doing different things, etc.), it reduces our maintainer burden (we just check that the tutorial is still there and that it works once in a while and take it down if it doesn't and there are no plans for its maintainers to fix it), and it allows external folks to potentially have their cookbook/ repo featured without having to maintain the tutorial in multiple places.
There is currently a new PR (#1398) that would add some Tutorial content (awesome that folks want to contribute!!), but we need to sort out how to best feature/ host this type of content.
I have tagged some people here that I think will be interested in this, but any and all feel free to chime in!
@andypbarrett @mfisher87 @asteiker @JessicaS11 @betolink