github / training-kit

Open source courseware for Git and GitHub

GitHub Training Kit

Open source courseware from the GitHub Professional Services team.

We ❤️ contributors like you

We’re eager to work with you, our user community, to improve these materials and develop new ones. Please check out our CONTRIBUTING guide for more information on getting started.

Looking for a resource that was once housed in training-kit?

This repository currently contains Git and GitHub cheat sheets. If you're looking for a project that used to be housed here, such as On-Demand training, reading lists, videos, and book recommendations, see this commit in the repository's history.

Projects used in training-kit

• We use Jekyll and Markdown.
• Our content is styled using the Primer CSS toolkit.

Packaging for viewing behind your firewall

If you'd like to have a copy of the files to be served from a web server inside your firewall, start by running script/package.

1. Run script/package to create a release tarball. This will be in the format release-XXXXXXX.tgz for you to take wherever you want.
2. To test this looks okay, create some folders mkdir -p test_site/kit.
3. Extract the release, tar -xzf release-XXXXXXX.tgz -C test_site/kit.
4. Switch into the test_site directory, cd test_site.
5. View the site:
   • For python version 2.x, run: python -m SimpleHTTPServer
   • For python version 3.x, run: python -m http.server
   • Note: Some servers are more advanced than others and can handle redirects, smart recognition of .html files, etc

Site content is licensed under CC-BY-4.0. CC-BY-4.0 gives you permission to use the content for almost any purpose but does not grant you any trademark permissions, so long as you note the license and give credit, such as follows:

Content based on github.github.com/training-kit/ used under the CC-BY-4.0 license.

Code used to build and test the site as well as code samples on the site, if any, are licensed under CC0-1.0. CC0 waives all copyright restrictions but does not grant you any trademark permissions.

This means you can use the content and code in this repository except for GitHub trademarks in your projects.

When you contribute to this repository you are doing so under the above licenses.

training-kit's Issues

Slide-only curriculum option

First raised by @johndbritton, there are frequent uses for the Kit's curriculum pages to consist of exclusively slide-only content without the lab or additional resource materials. Benefits:

1. Spacebar to advanced down through each slide, chapter
2. No cursor/mouse/trackpad scrolling needed to move past resource content
3. Appears more like on-screen slide deck

Support multiple usernames in `?teacher=<name>`

The querystring-parameter that provides the cover page with teacher's GitHub API-provided information should support a CSV. This provides single-page support when more than one instructor is teaching, or co-instructing is occurring.

Incorporate abstract/chapter summary in slides

Based on a Training team discussion, the curriculum "slides" would benefit from a summary or objectives "what you'll learn" list at the very beginning of the content.

Release 1.8.0

Tracking issue for Training-Kit release 1.7.x:

- [ ] Intermediate curriculum updates TBD
- [ ] Advanced curriculum updates TBD
- [ ] Longer lived branch examples, slide topics #247

• Chapter abstracts/summaries
  • Foundations slide deck #258, #292
  • Intermediate slide deck #298
  • Advanced slide deck #299
  • Style improvements in #288 should permit better appearance for this feature
• Objective list "checkboxes" in slide deck for each class #303
• Subversion Migration cheat sheet #283
• Cheat sheets web page as print layout
  • Git Cheat Sheet #295
  • Subversion to Git #293
• Fix "teacher" mode and slide-only mode toggle bugs #300
• White space corrections #297

Fleshing out the cheatsheet - Wait on materials or dive in now?

What's the procedure on fleshing out the cheatsheet? Like the Foundations, for example.

Is the idea that it's written up from the sessions and classes you're holding, and the repo is waiting for some breathing time between classes?

Or would it be okay to jump in and add a sentence or two here and there to help add some lines/definitions to the cheat sheet?

Release 1.7.0

This serves as the tracking issue for the upcoming 1.7.0 release of Training-Kit.

• Foundation curriculum updates #282

- [ ] Intermediate curriculum updates TBD
- [ ] Advanced curriculum updates TBD

• Liquid include deprecation #287
• Improved slide styling #288

Missing font/Octico/traced shape in Intermediate Remote Workflows diagram

Git Foundations Rebase interactive slide

Last step of Rebase interactive animation lists file index.html in commit 48E while in previous frame this file is not mentioned.

Am I missing something or listing this file introduces confusion?

Subversion to Git Migration cheat sheet PDF review

@github/training-teachers, The first page of the Subversion to Git Migration sheet is starting to feel close to shipping, but I'm looking for inputs on the second (back) sheet with the vocabulary.

I'm all 👂s for what the introductory paragraph might benefit from, raise, or just summarize that the table details out in grid format.

Repeated Octicons, visual hiccup

On Yosemite's Safari, I'm seeing Octicons oddly repeated:

And now, I can't reproduce it after a reboot.

TOC hidden in Firefox

I'm using Firefox 34.0.5 and the TOC ghosts away when my cursor is not hovering. It works 🅰️-🆗 in Chrome and Safari.

This is what I mean:

Hope that helps!

Improve Network diagram and `pull` and `fetch` indication arrows

Per @brntbeer regarding the Foundations slide deck chapter on Network:

Maybe explicitly saying "fetch" when the first arrow is drawn, showing the merge on the step after that with fetch in there, and then removing both of them and -- in bigger text -- write "Pull = Fetch+merge for current branch"

Organization and Team slide order flip?

In https://training.github.com/kit/foundations/#surveying-the-github-platform, as we get to the end of the major feature set, we mention teams before organizations.

Should this be reversed? I often think about this from the top down: " An organization acts like a user, but connects individuals together to repositories through teams."

Otherwise, im open to suggestions on how I could improve the way in which i talk about orgs and teams! 😄

Add GitHub Guides to Resources

The Training Materials/Training Kit needs a resources list, which should include https://guides.github.com.

.

Sorry about that. Sticky keys and laggy browser auto-created this issue.

problem with Github foundation link in the offline kit

for the offline Kit, the Github Foundations link is not working

see below

Git Foundations
A thorough course on GitHub and Git used in GitHub:Training classrooms

looking at index.html code I found out the cause,

this change is needed
<a href="git-foundations.html">Git Foundations</a> -> <a href="github-foundations.html">Git Foundations</a>

Download/Non-Web Resource Paths

Before we consider the downloadable resources officially shipped here on Materials, we need to reach consensus on a path that will remain unchanged for the foreseeable future.

Currently, the Cheat Sheet lives at this path:

http://training.github.com/materials/downloads/github-git-cheat-sheet.pdf

Though these materials may get updated, the path should always stay the same. Can we agree that /downloads is an acceptable path?

@github/training-teachers

Outdated cheat sheet (PT) PDF file

It's been a while since the PDF file of the Cheat Sheet in Portuguese was built (Jun 9, 2014), but I'm not sure if there is a schedule to build these things. It happens that it does not have the latest version of the md file (Oct 17, 2014).

In the PDF file, one of the descriptions is in Spanish:

$ git branch [nome-do-branch]
Crea una nueva rama

In the source file, it is correct though:

$ git branch [nome-do-branch]
Cria um novo branch

That was the only issue I noticed.

Thanks for the kit!

Bug: Ctrl-f in Chrome makes slides disappear

Steps to reproduce:

1. Navigate to http://training.github.com/kit/slides/github-advanced.html
2. Ctrl-f for any string that doesn't exist in the slide deck (this step may need to be repeated one or two times)
3. The deck view shows only the bottom
4. The slide view shows only a corner of the slide
   This issue is 100% reproducible.
   Pictures of the slide and deck view are attached.
   
   

@jordanmccullough

Slide "Help" JS Errros

The auto-showing Help panel for slide decks is experiencing JS issues.

Subversion to Git Migration Cheat Sheet

With the first draft of the Subversion to Git Migration Cheat Sheet shipped in Markdown, this is a preview of the upcoming PDF design layout.

@github/training-teachers, Can you give this some 👀 and submit PRs to the markdown for tuning that might make the layout or content feel optimal for this design?

Support Trainer name page by querystring and GitHub API

The current method for customizing the slide deck with a "Trainer" information page is burdensome.

Let's use a querystring for specifying a GitHub user's name (the teacher) and then utilizing the GitHub API to pull the public info for building this page instead.

Example:
https://training.github.com/kit/slides/github-foundations.html?gh_user=brntbeer

Git Cheat Sheet Japanese PDF Layout, Content

@hissy and @dice:

I have completed the initial copy-paste of the Japanese Markdown file's content into the Git Cheat Sheet PDF layout.

The text areas were adjusted where possible for the length of the text, including the larger box in the トラッキングの制限 section. However, some text runs longer than the original design planned.

I can adapt the layout to fit the text if needed. However, is there a possibility to restructure and shorten the content of these sections? This is coming from someone unfamiliar with the language of 🗾. 😄

Arrows identifying the descriptions that currently spill out of design boxes:

Log command missing from slide with options switches

Second group of log commands with option switches for searching are missing log.

Up and Running workshop guide?

I've been writing up a teacher-focused guide for the "Git & GitHub, Up & Running" workshop I've been doing, and was wondering about the best place for that to live. The slides/concepts are a subset of the Foundations class, but I think the format is fairly different, in that they are all building a personal Pages site, and then doing a pull request to each others' repositories to add an "interesting fact" about that person.

Would it be fair to say that the workbooks on the site are student-focused, rather than intended for the person who runs the workshop? I was going to start a pull request to add this third class type to the Materials page, but am curious to hear if others think it would be a good fit. Thanks!

Table of Content doesn't show by default

Because the icon is so small, it's easy to miss for new users. What if we showed it by default and had the option to hide it later?

Minify JS and CSS

All JS and CSS involved in the Kit and Slides need minified for more efficient transport.

SVGs don't animate in unified class material document

In our in-use unified workbooks, we insert the SVGs with a special liquid capture, but it doesn't yet respect animation of the layers that @jordanmccullough worked so hard to get working in the slide decks such as https://training.github.com/kit/slides/github-foundations.html#/9/2

The idea would be for some decoration on the margin, or just clicking in the SVG itself to advance the animation step by step.

Buildscript for generating update CSS from SASS

Per the discussion here, an easy to use buildscript should be available to generate any CSS artifacts from updated SASS files.

A plus would be if the script also uses the necessary SASS switches to compact the CSS and generated simplest possible output (no comments, whitespace, etc.).

Crossfade fragment transitions in SVG diagrams

Tried figuring this out myself, but wasn't getting anywhere 😕 The fragment transitions on certain slides (e.g. the one below) feel sluggish since it takes two keypresses to advance to the next annotation. I don't think that the middle state is useful, so would be nice to collapse that.

/cc @jordanmccullough

Alt+Click does not work

Some recent change to the layout or overlay in the slides prevent the useful alt+click support of RevealJS.

rebase slides missing from advance =(

Seems the imaging of rebase is missing! =(

Add image of Try Git to Foundations, Intermediate one-page curriculum

Continuing the conversation from #187, it seems like elevating Try Git to an image in the curriculum is helpful to our goals.

Tweak home page layout

Now that the Training-Materials repo has more established content, the access and layout of the home page needs additional attention. This initial Issue serves as a reminder to visit this design revision effort 🔜.

Description / Mention of Longer lived branch workflow

I've taught a few people a version of the GitHub flow that uses longer lived branches, wondering if there's a place in the workflow section of Advanced for us to describe this?

This is also the workflow that we'll be using for this repo moving forward i believe.

Can't insert a SVG more than once

In https://training.github.com/kit/foundations/ an SVG can only be inserted once with the

{% capture svg_path %}../assets/diagrams/distributed-version-control.svg{% endcapture %}
{% include svg %}

If inserted a second time, the graphic doesn't show up and a white blank space is rendered instead.

user.name and user.email in intermediate start out without flags, and don't work

https://training.github.com/kit/intermediate/ starts out listing the user.name and user.email, but no flag for the level of setting it at.

The slides should reflect that this needs --global for it.

Anchor tags in unified curriculum only use first word of H3

The in-page anchor generated for each section of the document only uses the first word of each H3. If the same word begins a second H3, both will be highlighted in the navigation bar. I worked around this by numbering all the H3s.

Mix of tabs and spaces in stylesheets

I noticed we have a mix of tabs and spaces in some of the stylesheets. @jordanmccullough what are your thoughts on adding those to spaces?

H3 headings are eaten in silence in workbook

On the workbook it looks like the subheadings (###) are being eaten up by the parser that handles hiding away the ###Details sections between "Summary" and "Details" views.

In this screenshot example, it's missing "Checking for remotes" and "Adding an upstream".

Responsive (tablet) friendly design

In addition to the generic desktop friendly design, some adjustments to the stylesheet after #46 completes would help with different screen sizes.

This also has the advantage of making the Workbook content more useful as supplementary when Training Kit users are presenting and keep the content open on a tablet while using the desktop for the slides projection.

Installing Git cheatsheet missing second part of combination

"Installing Git" section of the GitHub Foundations Cheat Sheet appears to leave things on a cliffhanger:

Git can be installed via a combination of the GitHub GUI and

There is something missing here isn't there?

Found some minor issues in the Spanish translation of 'github-foundations.md'

I noticed a few minor issues (misspellings, typos) over in the Spanish translation of 'github-foundations.md'. I would like to submit a pull request in order to fix them. Is this is welcome contribution right now?

Replace public slides and workbook with unified curriculum

• Link the workbook links to the dark-shipped unified slides+workbook
• Toggle the existing workbooks (for salvaging) to be dark shipped (old.html), or delete them
• Create redirects for all slide URLs to the new unified workbooks + slides
• Adjust the public https://training.github.com/kit page to delete the slides section and combine the wording with the workbook section

A Beginner's Request

Dear GitHub Training,

I have used github before to simply modify a java thing for minecraft. I had total step by step instructions.

Now, I want to learn how to create my own programs using github, but other than the above I haven't programmed a thing in my life.

I tried to complerte the lesson that gives out badges but it crashed and I can't get it back...

I would very much like it if you could possibly create new forks for the different training leves, in one file pocket, like Begin here, Intermediate here, and advanced here...

Also, if possible, can these be further divided by language?

No, Not Eng Fr Spa; but C++ Python, Java... etc?

Can anyone help?
Leah

Add `?` tips and shortcuts to curriculum

Started here, helpful tips including the URL querystring trick ?teacher=[githubusername] and resources would benefit from showing in a ? popover.

Organizing history for optimal workflow breaks TOC

We currently have two <h2> elements for the section of "organizing history for optimal workflow. This also shows as two TOC elements on the right hand side.

Use local vs CDN of library dependencies

Given the Kit is shipped with a version release, and is expected to run locally and offline, the CDN-based dependencies need to be resolved.

Example:
https://github.com/github/training-kit/blob/master/_layouts/site.html#L17

ES Cheat Sheet Fine Tuning for Text Spillover

@leereilly, any thoughts on how we might best shorten some of the EN-->ES Git translations?

If at all possible, I'd ❤️ not needing to wrap any of the command descriptions to two lines. The first pass to resolve this was shrinking the page margins down to 0.25", and from a design standpoint, I dare not go any closer.

The font size is already near the lower limit, so I made the call that shrinking below 9pt is probably not an optimal solution.

The commands with the longer descriptions include these (also shown in the page PNGs below):

git config --global user.name

git diff

git diff --staged

git commit -m

git rm

git rm --cached

git log --follow

git reset

Support internationalization

Objectives

• Add language field to YAML frontmatter
• Update template for HTML to definte lang attribute
• Include language toggle/list for all docs translated

Method

• Copy content to ISO named sub-folders