Join GitHub today
GitHub is home to over 50 million developers working together to host and review code, manage projects, and build software together.
Sign upGitHub is where the world builds software
Millions of developers and companies build, ship, and maintain their software on GitHub — the largest and most advanced development platform in the world.
Newer, Friendlier README #421
Conversation
Converted the existing instructions into a numbered list to be more consistence with the Packaging for Viewing Behind Your Firewall section.
|
Just some thoughts, take em or leave em! |
|
|
||
| We know that many of the users of this repository are just focused on getting the materials and teaching from them. We've made that easy. | ||
| - **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](https://services.github.com/on-demand)). | ||
| - **You have an idea to make it better:** we :heart: new ideas! We invite you to open a new [Issue](https://github.com/github/training-kit/issues) to kick off the process. |
brntbeer
Dec 6, 2016
Member
What about starting a PR to even be able to talk about something more concrete when wanting to make something better?
|
|
||
| ### Class Material | ||
| - Our current [on-demand courses](https://services.github.com/on-demand/) can be found in the [paths directory](https://github.com/github/training-kit/tree/master/paths) |
brntbeer
Dec 6, 2016
Member
Small nit-pick but I think we can use relative paths here: [paths directory](/paths)
crichID
Dec 6, 2016
Author
Collaborator
@brntbeer so in my brain I was thinking that we should link back to the parent repo just in case someone is viewing the README in their fork??? Now that I say it out loud, it is a dumb idea
|
Thanks for moving this forward so quickly, @crichID! |
|
@crichID What are your thoughts on including badges at the top of the Readme, similar to those found on Atom? I like it because if we decide to add a Slack channel then we can also include that badge. Also, badges are fairly consistent in the Open Source community, and it would be cool to be an exemplary repository in every nuance that we can. Also, this isn't a blocker for now, but this might be a Here's the link to our Travis build if yes (I'm also happy to commit this in): |
|
@hollenberry I like the Travis badge so |
@hollenberry I may only speak for myself, but from what I understand, please feel free to go ahead and make these types of commits (both now and in the future) and if there is opposition to it, we can always remove it later. As hubot would say, you are trusted. |
|
@crichID |
|
|
||
| This is the official courseware for the [GitHub Training Team](http://training.github.com). This repository provides open source materials and slides for teaching GitHub Classes under the [_CC BY 4.0_ license](http://creativecommons.org/licenses/by/4.0/). | ||
| 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](https://github.com/github/training-kit/blob/master/LICENSE). |
brianamarie
Dec 8, 2016
Contributor
|
|
||
| ## File Format | ||
| 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](https://github.com/github/scripts-to-rule-them-all)! |
brianamarie
Dec 8, 2016
Contributor
Should we include that Ruby and homebrew are necessary for this process? (Are they?)
|
|
||
| ## Theme Documentation | ||
| 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`. |
|
Update:
|
|
Woohoo! Slack channel button works! @hollenberry Not a criticism, just a general thought: Do we want to maintain both a Gitter community and a Slack community, or does it make sense to keep the chat to the same service? |
Capitalized Jekyll to be consistent with the Jekyll website Added link to the Jekyll website
The original reasoning behind Gitter was to reduce the number of accounts needed by someone to join, and the integration with |
|
@github/services-training based on #430 I thought it might be a good idea to go ahead and |

Formed in 2009, the Archive Team (not to be confused with the archive.org Archive-It Team) is a rogue archivist collective dedicated to saving copies of rapidly dying or deleted websites for the sake of history and digital heritage. The group is 100% composed of volunteers and interested parties, and has expanded into a large amount of related projects for saving online and digital history.



This pull request is a follow up to #415 and will strive to create a friendly README.
If you are reading this, what's missing? How can we make the process of customizing, building, and contributing to these materials less intimidating?
@github/services-training