search

ProjectPythia / pythia-foundations

Jupyterbook source for the Foundations collection
http://foundations.projectpythia.org
Apache License 2.0
60 stars 43 forks source link

Git installation in the git section? #472

Open kafitzgerald opened 4 months ago

kafitzgerald commented 4 months ago

We've had some folks running through the git / GitHub section get stuck on the git install bit. I wonder if it might be helpful to more explicitly point to some install resources. I realize this is a bit different between operating systems, etc. so potentially add some complexity.

Pointing to the relevant section in the Software Carpentry Git Novice lesson could work too: https://swcarpentry.github.io/git-novice/#installing-git

Happy to make a quick PR if this is of interest. And apologies if I missed something.

brian-rose commented 4 months ago

Hmm, good point! I don't think Foundations addresses installation of git at all. In this section we just say

Git is FOSS and comes pre-installed on many Linux and Mac OS systems.

Others may disagree, but I expect that Pythia does not want the burden of keeping an up-to-date cross-platform guide on how to install git. My reasoning here is that this would be a significant maintenance burden that is not geoscience-specific.

I see that we already link to the Carpentries site on git in the "References" section of this notebook. What about just adding a note (and link) right below the text I quoted above, saying something like "Don't have git on your system already? Check out these installation guides from the Carpentries"

kafitzgerald commented 4 months ago

I think that makes a lot of sense!