Skip to content

Instantly share code, notes, and snippets.

@amandabee
Last active August 29, 2015 14:03
Show Gist options
  • Star 2 You must be signed in to star a gist
  • Fork 1 You must be signed in to fork a gist
  • Save amandabee/1fe6df548637e8dafdcd to your computer and use it in GitHub Desktop.
Save amandabee/1fe6df548637e8dafdcd to your computer and use it in GitHub Desktop.
You should use Git

Git is a version control system. Github is a proprietary hosting service that manages central git repositories. A git repository doesn't have to be public, but there are some great free hosts available if you do want to make your work available. Github, obviously, or Gitorious, especially if you're offended by github's ugly gender politics. Github's GUI is much nicer than any generalized Git GUI's I've seen, which is a vote for using Github, but it really doesn't matter.

So here are a few good reasons you should use git to manage teaching materials:

  • Greg Wilson explains it pretty well to a Python conference. You have to listen to him talk about a few other things first, but the whole talk is interesting so go ahead.

Any newsroom with an apps team worth their salt is publishing tools to github:

so it is worth getting acclimated to a vital tool in their collective toolbox.

The tools we teach are on Github

Teachers use it

It isn't hard.

Mindy McAdams wrote a GitHub in 10 Simple Steps tutorial for Mac and Windows users.

I write most documents in Markdown which is the world's simplest markup language. Tools like Mou and ReText make it even easier to work with.

It lets me look back at how I structured a lesson last semester, rework the lesson plan and materials and keep moving forward. It lets me share lesson plans with my colleagues. It let's me see exactly what a collaborator changed on any one document or lesson plan.

I don't hide the repository from students, but I always remind them that if they do find it they should keep in mind that I maintain that repository for myself and they should look to the class site for materials that I've reviewed, edited for the current semester and deadlines, and published for their use.

I still keep a private document (in LibreOffice Writer, but Word is fine, too) where I break down each class period and keep notes about what I'm going to discuss. I don't need to make my notes on common problems I'm seeing in student work public, mostly because I don't want to edit those for the public eye. But most of my slide decks and lesson plans? They are in a git repository somewhere. So I can re-purpose them. And for the fall, I'm looking forward to dropping the class Wordpress site altogether in favor of Github pages.

PS. I'm open to other version control systems, but I prefer Git to Subversion primarily because it does a better job of managing offline checkins. I can makes changes and commit them over and over before I ever go online and push those changes to a remote repository. That's handy if you ride Amtrak as much as I used to, or if you work outside the office as much as I get to.

@dannguyen
Copy link

[removed the list of course since it's already posted here]

https://github.com/dannguyen/github-for-portfolios

I'll finish this partially-completed guide later this summer, but it's meant to be a walkthrough for non-coders on how to use Github to publish and manage things (e.g. webpages, lesson plans, etc...)...I think for most people, the concepts of forking, pull-requests, collaborating, command-line Git, etc. aren't features they need to jump into right away.

@macloo
Copy link

macloo commented Jul 15, 2014

GitHub in 10 Simple Steps. This is the tutorial I wrote for students last spring (they were on Macs):
http://bit.ly/mmgittut

GitHub for Windows. Then I went into a Windows environment and wrote a tutorial for Windows:
http://bit.ly/mmgitwin

Please note: Both tutes use the GitHub for Mac/Windows apps, not the command line.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment