The Wayback Machine - https://web.archive.org/web/20201123220031/https://github.com/github/training-kit/pull/421
Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Newer, Friendlier README #421

Merged
merged 11 commits into from Dec 16, 2016
Merged

Newer, Friendlier README #421

merged 11 commits into from Dec 16, 2016

Conversation

@crichID
Copy link
Collaborator

@crichID crichID commented Dec 6, 2016

⚠️ Work in Progress ⚠️

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

Converted the existing instructions into a numbered list to be more consistence with the Packaging for Viewing Behind Your Firewall section.
Copy link
Member

@brntbeer brntbeer left a comment

Just some thoughts, take em or leave em!

README.md Outdated

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.

This comment has been minimized.

@brntbeer

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?

This comment has been minimized.

@crichID

crichID Dec 6, 2016
Author Collaborator

💯 agreed! Changing now!

README.md Outdated

### 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)

This comment has been minimized.

@brntbeer

brntbeer Dec 6, 2016
Member

Small nit-pick but I think we can use relative paths here: [paths directory](/paths)

This comment has been minimized.

@crichID

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 😜 Thank you for catching that!

@hectorsector
Copy link
Member

@hectorsector hectorsector commented Dec 6, 2016

@crichID I think this looks great! I would just add @brntbeer's suggestion:

What about starting a PR to even be able to talk about something more concrete when wanting to make something better?

Copy link
Member

@hectorsector hectorsector left a comment

Thanks for moving this forward so quickly, @crichID!

@hollenberry
Copy link
Contributor

@hollenberry hollenberry commented Dec 6, 2016

@crichID What are your thoughts on including badges at the top of the Readme, similar to those found on Atom?

screen shot 2016-12-06 at 10 39 47 am

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 place for a banner based on the title card that @loranallensmith is in the process of designing for our videos (brand strengthening!) 😄

Here's the link to our Travis build if yes (I'm also happy to commit this in):

Linux Build Status

@beardofedu
Copy link
Contributor

@beardofedu beardofedu commented Dec 6, 2016

@hollenberry I like the Travis badge so 👍 from me 😄

@brianamarie
Copy link
Contributor

@brianamarie brianamarie commented Dec 8, 2016

Here's the link to our Travis build if yes (I'm also happy to commit this in):

@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. 🤖

Copy link
Contributor

@brianamarie brianamarie left a comment

@crichID 🙇 This is awesome. I made a few general comments about little things, and I have a few commits to add as well. 🎉 These improvements are so exciting!

README.md Outdated

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).

This comment has been minimized.

@brianamarie

brianamarie Dec 8, 2016
Contributor

🤔 This is probably my naïveté on the subject, but do we need to include the word license twice?

README.md Outdated

## 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)!

This comment has been minimized.

@brianamarie

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`.

This comment has been minimized.

@brianamarie

brianamarie Dec 8, 2016
Contributor

🎉 🎈 🍕 😻 💯

brianamarie and others added 5 commits Dec 8, 2016
@hollenberry
Copy link
Contributor

@hollenberry hollenberry commented Dec 9, 2016

Update:

  • I created a Heroku server for Slack invitations, as well as a Slack group. This process was super easy (though misconceptions on my end made this a massive time-wasting endeavor), and I'd ❤️ if a few of you can test this by joining the channel via the button instead of a direct invite.
  • I spent a little while attempting to add this badge : Dependency Status , but for our server Dependency Status
    • Spoiler alert: It doesn't work. We need a package.json file to list our dependencies. Currently, that file appears to be a bower.json file.
  • I added an image. to @loranallensmith
@brianamarie
Copy link
Contributor

@brianamarie brianamarie commented Dec 9, 2016

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
@hectorsector
Copy link
Member

@hectorsector hectorsector commented Dec 9, 2016

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?

The original reasoning behind Gitter was to reduce the number of accounts needed by someone to join, and the integration with :octocat: where we can easily link to issues/PRs, and the support of Markdown. In either case, if we start using Slack I don't think it makes sense to keep both chat services and we should then stop using Gitter.

@crichID crichID changed the title Newer, Friendlier README and CONTRIBUTING Dec 16, 2016
@crichID
Copy link
Collaborator Author

@crichID crichID commented Dec 16, 2016

@github/services-training based on #430 I thought it might be a good idea to go ahead and 🚢 this. I removed the chat link while we decide whether to stick with Gitter or switch to Slack. I also reduced the scope of this PR to the README since the CONTRIBUTING guide still needs some ❤️! Please feel free to open a new PR if you see additional changes we need to make.

@crichID crichID merged commit ba8d85d into master Dec 16, 2016
2 checks passed
2 checks passed
continuous-integration/travis-ci/pr The Travis CI build passed
Details
continuous-integration/travis-ci/push The Travis CI build passed
Details
@crichID crichID deleted the welcome-to-all branch Dec 16, 2016
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.