Teaching with GitHub
WAML 2020 Preconference Workshop
Outline
- GitHub—Demystified!
- How do we use GitHub in practice?
- Overview of GitHub Pages
- How do we use Pages in practice?
PSA:
If you have not created an account on GitHub.com, please do so now!
Also, just make sure you can log-in.
But first...Why use GitHub for your workshops?
- GitHub is free, open, and very approachable.
- Enables collaboration, reproducibility, & version control.
- Flexible and extendable.
What is "Git"?
- Git = version control software
- Free and open source
- Git is for your computer—you run it locally
- Project-specific repositories hold past versions of files
- Mostly a command-line tool
- Very useful for project managment
What is "GitHub"?
- GitHub.com is a website that uses Git
- Lets you store a git repo on the web
- Link a local repo to a web repo (hello backup!)
- Allows for multiple contributors to a repo
- Built-in tools for managing collabs/QC
- Very popular w/ devlopers/ programmers/ coders
Intimidating?
We get it.
We made a glossary.
A few terms:
- Local Repo: A repo on your computer.
- Remote Repo: A repo on GH.
- Fork: Make a remote copy of a GH repo.
- Clone: Make a local copy of a GH repo.
- Pull Request: Suggest an edit to a GH repo.
How do we use GitHub?
Let us count the ways...
What is GitHub Pages?
- GitHub Pages: static webpages hosted on GitHub.
- Free! Easy configuration!
- Add webpages and associated content to a repo...
- ...click a couple of buttons...
- ...and BAM! you have a website.
Don't want to deal with HTML/CSS/JS?
No problem!
Jekyll
- Static sites generator
- Transforms Markdown docs to sites
- GitHub Pages are powered by Jekyll
- Once deployed, create new pages using Markdown
That's a wrap on the slides!
Time for a break!
We will continue with Hands On!