Open source on demand courses and cheat sheets for Git and GitHub
CSS HTML JavaScript Other
Latest commit 8c89909 Jan 17, 2017 @brianamarie brianamarie committed on GitHub Merge pull request #434 from github/remove-beta
Remove beta tags from Desktop & CLI
Permalink
Failed to load latest commit information.
.github Change heading level for Testing Locally Jan 12, 2017
_data Merge pull request #434 from github/remove-beta Jan 17, 2017
_includes Merge pull request #434 from github/remove-beta Jan 17, 2017
_javascript Removed hypens from data mapping Mar 11, 2016
_layouts Merge pull request #417 from github/reset-course Jan 17, 2017
_pages update to ghd beta Oct 28, 2016
_stylesheets add stylesheets Oct 12, 2016
advanced remove include-slides Sep 28, 2016
assets Re-compress png images losslessly via zopflipng Dec 15, 2016
downloads Merge pull request #422 from github/submodule-subtree-guide Jan 17, 2017
foundations change deprecation notice to be in layout instead of all index files Jan 26, 2016
glossary Create ja.yml Jun 13, 2014
images Merge pull request #417 from github/reset-course Jan 17, 2017
intermediate change deprecation notice to be in layout instead of all index files Jan 26, 2016
js Add jQuery in original Training web site location Sep 10, 2014
paths Merge pull request #417 from github/reset-course Jan 17, 2017
script remove old github for everyone and devs courses Nov 21, 2016
vendor/cache update gems for github-pages being latest Apr 29, 2016
.bowerrc Add Bower Dec 5, 2014
.gitignore Script to create a release bundle Jan 9, 2014
.gitmodules remove hydeslide dependencies from .gitmodules Oct 11, 2016
.travis.yml run script/cibuild instead for posterity and remove rbenv variable fr… Jun 6, 2016
CONTRIBUTING.md teach.github is dead, long live training-kit Jul 25, 2014
Gemfile remove version of github-pages, needs to be most updated Apr 29, 2016
Gemfile.lock update gems for github-pages being latest Apr 29, 2016
LICENSE adding license to training-kit ported from on-demand Nov 18, 2016
README.md Remove chat for now Dec 16, 2016
Rakefile html-proofer isn't even used here Jun 7, 2016
_config.yml remove url key from config Nov 18, 2016
bower.json Add Bower Dec 5, 2014
community.md Center handles and avatars Nov 30, 2016
index.html replace index with on-demand Oct 12, 2016
index.md replace index with on-demand Oct 12, 2016
self-study.md Change permalink Dec 2, 2016
us-holidays.md update based on Hubber holidays Dec 7, 2016

README.md

servicesbanner

Build Status

GitHub Training Kit

Home of GitHub's On-Demand training

This repository contains the completely open source on-demand training hosted at https://services.github.com/on-demand/. These materials are provided under a Creative Commons License license.

We ❤️ Contributors Like You!

We’re eager to work with you, our user community to improve these materials and develop new ones. Here's how you can help:

  • You spotted a mistake: please feel free to fork the repository and submit a change via Pull Request (not sure how to do that, we have a course for you).
  • You have an idea to make it better: we ❤️ new ideas! We invite you to open a new Issue if you want to talk about it, or you can fork this repository and submit your idea via a Pull Request.
  • You just want to help: check out the open issues for projects you can tackle, review an open pull request, or check out the project ROADMAP.

For more information on contributing to this repository, check out our CONTRIBUTING guide.

🗺 Finding Your Way

This repository contains three primary resources:

Our Content Philosophy

We are eager to create materials that are easy to use and follow! To that end, here are a few guidelines we ask you to keep in mind:

  • We focus on providing clear, step-by-step instructions for completing an activity, giving the learner the opportunity to study the concept in greater detail with the Tell Me Why feature.
  • We focus on minimalism.
  • We use Jekyll and Markdown.
  • The theme for the on-demand training is Minimal Mistakes and has some amazing documentation.

Building and Packaging

Building and Testing Locally

When you are ready to test your changes, you will want to build the repository locally. This is fully automated through a series of shell scripts based the scripts to rule them all!

To perform a build of the materials perform the following:

  1. Run script/setup
  2. Run script/server.
    • When successful, the script will initiate a local server at http://127.0.0.1:4000/on-demand.
  3. Simply paste that into your favorite web-browser and you will be ready to test.

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 of 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. Untar 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 with python -m SimpleHTTPServer. Note: Some servers are obviously more advanced than others and can handle redirects, smart recognition of .html files, etc

Licenses

Site content is licensed under CC-BY-4.0. CC-BY-4.0 gives you permission to use 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.com/github/on-demand 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 own projects.

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