November 30, 2018
9:00 am - 12:30 pm
Instructors: Jamene Brooks-Kieffer
Helpers: Tami Albin, Scott Hanrath, Patrice-Andre Prud'homme
This hands-on workshop draws on Git and GitHub lessons from Library Carpentry and the Mozilla Science Lab to introduce version control and collaboration using these common tools. Participants will be encouraged to help one another and to apply what they have learned to their own work problems.
For more information on the Library Carpentry curriculum, please see "Library Carpentry: software skills training for library professionals". For more learning materials from the Mozilla Science Lab, please see the Lab's Resources page.
Who: The course is for librarians, archivists, and other information workers. You don't need to have any previous knowledge of the tools that will be presented at the workshop.
Where: Midwest Genealogy Center, 3440 South Lee's Summit Road, Independence, MO. Get directions with OpenStreetMap or Google Maps.
When: November 30, 2018. Add to your Google Calendar.
Requirements: Participants must bring a laptop with a Mac, Linux, or Windows operating system (not a tablet, Chromebook, etc.) that they have administrative privileges on. They should have a few specific software packages installed (listed below). They are also required to abide by Library Carpentry's Code of Conduct.
Accessibility: We are committed to making this workshop accessible to everybody. The workshop organizers have checked that:
Materials will be provided in advance of the workshop and large-print handouts are available if needed by notifying the organizers in advance. If we can help making learning easier for you (e.g. sign-language interpreters, lactation facilities) please get in touch (using contact details below) and we will attempt to provide them.
Contact: Please email jamenebk@ku.edu for more information.
09:00 | Introductions |
09:10 | Getting started with Git |
10:05 | Collaborating using GitHub |
11:05 | Contributing to an open project using GitHub |
12:05 | Tour of the ArchivesSpace GitHub repository |
12:30 | End |
We will use this collaborative document for chatting, taking notes, and sharing URLs and bits of code.
To participate in this workshop, you will need access to the software described below. In addition, you will need an up-to-date web browser and a GitHub account.
We maintain a list of common issues that occur during installation as a reference for instructors that may be useful on the Configuration Problems and Solutions wiki page.
Bash is a commonly-used shell that gives you the power to do simple tasks more quickly.
cmd
and press [Enter])setx HOME "%USERPROFILE%"
SUCCESS: Specified value was saved.
exit
then pressing [Enter]This will provide you with both Git and Bash in the Git Bash program.
The default shell in all versions of macOS is Bash, so no
need to install anything. You access Bash from the Terminal
(found in
/Applications/Utilities
).
See the Git installation video tutorial
for an example on how to open the Terminal.
You may want to keep
Terminal in your dock for this workshop.
The default shell is usually Bash, but if your
machine is set up differently you can run it by opening a
terminal and typing bash
. There is no need to
install anything.
Git is a version control system that lets you track who made changes to what when and has options for easily updating a shared or public version of your code on github.com. You will need a supported web browser (current versions of Chrome, Firefox or Safari, or Internet Explorer version 9 or above).
You will need an account at github.com for parts of the Git lesson. Basic GitHub accounts are free. We encourage you to create a GitHub account if you don't have one already. Please consider what personal information you'd like to reveal. For example, you may want to review these instructions for keeping your email address private provided at GitHub.
Git should be installed on your computer as part of your Bash install (described above).
For OS X 10.9 and higher, install Git for Mac
by downloading and running the most recent "mavericks" installer from
this list.
Because this installer is not signed by the developer, you may have to
right click (control click) on the .pkg file, click Open, and click
Open on the pop up window.
After installing Git, there will not be anything in your /Applications
folder,
as Git is a command line program.
For older versions of OS X (10.5-10.8) use the
most recent available installer labelled "snow-leopard"
available here.
If Git is not already available on your machine you can try to
install it via your distro's package manager. For Debian/Ubuntu run
sudo apt-get install git
and for Fedora run
sudo dnf install git
.
When you're writing code, it's nice to have a text editor that is
optimized for writing code, with features like automatic
color-coding of key words. The default text editor on macOS and
Linux is usually set to Vim, which is not famous for being
intuitive. If you accidentally find yourself stuck in it, try
typing the escape key, followed by :q!
(colon, lower-case 'q',
exclamation mark), then hitting Return to return to the shell.
nano is a basic editor and the default that instructors use in the workshop. It is installed along with Git.
Others editors that you can use are Notepad++ or Sublime Text. Be aware that you must add its installation directory to your system path. Please ask your instructor to help you do this.
nano is a basic editor and the default that instructors use in the workshop. See the Git installation video tutorial for an example on how to open nano. It should be pre-installed.
Others editors that you can use are Text Wrangler or Sublime Text.
nano is a basic editor and the default that instructors use in the workshop. It should be pre-installed.
Others editors that you can use are Gedit, Kate or Sublime Text.