Skip to content

Instantly share code, notes, and snippets.

@jarvisc1

jarvisc1/LICENSE

Created April 9, 2016 13:07
Show Gist options
  • Save jarvisc1/09f9088aef5b5d88d35d346147f3ff07 to your computer and use it in GitHub Desktop.
Save jarvisc1/09f9088aef5b5d88d35d346147f3ff07 to your computer and use it in GitHub Desktop.
Download ZIP
Raw
README.md

Hackathon GitHub Intro

Introduction into GitHub for Hackathon

Usage

Overview / Layout grid

  • Press escape
  • Navigate to slide
  • Press enter to select

Speaker notes

  • Visit deployed version of slides and press s to view speaker's view (inc. notes).

Remote control

Using RevealJS for Slides

And for revealjs remote control via phone

Forking and Customising

  • Fork the Project/Repo
  • Add remote it remote add upstream git@github.com:open-micro-presentations/github-intro.git
  • To fetch upstream changes git fetch upstream
  • To merge upstream changes git merge upstream/gh-pages

More information on original GitHub documentation

Improvements

If any non-custom improvements are made, create a Pull Request and submit these back

View presentation on http://open-micro-presentations.github.io/github-intro/

Raw
index.html
<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>Introduction to GitHub Presentation</title>
<meta name="description" content="Introduction to GitHub Presentation">
<meta name="author" content="Eddie Jaoude">
<meta name="apple-mobile-web-app-capable" content="yes">
<meta name="apple-mobile-web-app-status-bar-style" content="black-translucent">
<meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1.0, user-scalable=no, minimal-ui">
<link rel="stylesheet" href="css/reveal.css">
<link rel="stylesheet" href="css/theme/black.css" id="theme">
<!-- Code syntax highlighting -->
<link rel="stylesheet" href="lib/css/zenburn.css">
<link rel="stylesheet" href="css/acornhack.css">
<!-- Printing and PDF exports -->
<script>
var link = document.createElement( 'link' );
link.rel = 'stylesheet';
link.type = 'text/css';
link.href = window.location.search.match( /print-pdf/gi ) ? 'css/print/pdf.css' : 'css/print/paper.css';
document.getElementsByTagName( 'head' )[0].appendChild( link );
</script>
<!--[if lt IE 9]>
<script src="lib/js/html5shiv.js"></script>
<![endif]-->
</head>
<body>
<div class="reveal">
<div class="slides">
<section>
<h1>GitHub</h1>
<h3>Introduction</h3>
<p>
<small>
Created by <a href="https://github.com/open-micro-presentations">OpenMicroPresentations</a>
</small>
</p>
</section>
<section>
<section>
<h1>GitHub</h1>
<h3>What is GitHub?</h3>
<p>
<small>
<a href="https://github.com">https://github.com</a>
</small>
</p>
<aside class="notes">
<p>Started out as Free VCS coding hosting</p>
<p>Other VCS(s): Git, SVN, CVS ...</p>
<p>UI for Git or other VCS</p>
</aside>
</section>
<section>
<h3>Facebook for code</h3>
<p>With a community of more than 12 million people</p>
<p>Discover, use, and contribute to over 31 million projects using a powerful collaborative development workflow</p>
<p>
<small>
<a href="https://github.com/about">https://github.com/about</a>
</small>
</p>
<aside class="notes">
<p>This is now and still growing</p>
</aside>
</section>
<section>
<h3>Missed an event?</h3>
<img src="images/community-not.jpg" />
<aside class="notes">
<p>Missed a party / event</p>
<p>Facebook you can comment retrospectively</p>
</aside>
</section>
<section>
<h3>Part of a community</h3>
<img src="images/community.png" />
<aside class="notes">
<p>Open Source part of a community</p>
<p>Never too late to join & take part</p>
</aside>
</section>
</section>
<section>
<section>
<h1>Organisation</h1>
</section>
<section>
<img src="images/github-organisation.png" />
<aside class="notes">
<p>Describe the Organisation page layout</p>
</aside>
</section>
</section>
<section>
<section>
<h1>User</h1>
</section>
<section>
<img src="images/github-user.png" />
<aside class="notes">
<p>Describe the User page layout</p>
</aside>
</section>
</section>
<section>
<section>
<h1>Repository</h1>
<p>You can have more than one per Project</p>
<aside class="notes">
<p>Project or part of a project</p>
<p>Repo for short</p>
</aside>
</section>
<section>
<img src="images/github-project.png" />
<aside class="notes">
<p>Describe the Project page layout</p>
</aside>
</section>
<section>
<p>Example repo names for single Project</p>
<table>
<tr>
<th>Frontend / Client-side</th>
<th>Backend / Server-side</th>
</tr>
<tr>
<td>MyApp-iphone</td>
<td>MyApp-authentication-api</td>
</tr>
<tr>
<td>MyApp-android</td>
<td>MyApp-blog-api</td>
</tr>
<tr>
<td>MyApp-web-ui</td>
<td>MyApp-comments-api</td>
</tr>
<tr>
<td></td>
<td>MyApp-health-api</td>
</tr>
<tr>
<td></td>
<td>...</td>
</tr>
</table>
<aside class="notes">
<p>Projects usually made up of multiple parts</p>
<p>Each part has a single responsibility</p>
</aside>
</section>
<section>
<h2>Commit History</h2>
<img src="images/github-commits.png" />
<aside class="notes">
<p>Audit Log</p>
<p>Undo / Redo</p>
<p>Good commit messages</p>
</aside>
</section>
</section>
<section>
<section>
<h2>Issue section</h2>
<p>Log all ideas / tasks etc</p>
<p>
<small>
<a href="https://guides.github.com/features/issues/">https://guides.github.com/features/issues/</a>
</small>
</p>
<aside class="notes">
<p>This is your friend</p>
<p>Draw drop screenshots / diagrams</p>
<p>Markdown is used</p>
</aside>
</section>
<section>
<img src="images/github-issues.png" />
</section>
</section>
<section>
<section>
<h2>Milestones section</h2>
<p>Groups of Issues</p>
<p>
<small>
<a href="https://guides.github.com/features/issues/">https://guides.github.com/features/issues/</a>
</small>
</p>
<aside class="notes">
<p>This is also your friend</p>
</aside>
</section>
<section>
<img src="images/github-milestones.png" />
</section>
</section>
<section>
<section>
<h1>Wiki</h1>
<p>Documentation / Presentation ideas etc</p>
<aside class="notes">
<p>This is also your friend</p>
<p>Markdown is used</p>
</aside>
</section>
<section>
<img src="images/github-wiki.png" />
</section>
</section>
<section>
<section>
<h1>Markdown</h1>
<p>
<small>
<a href="https://help.github.com/articles/basic-writing-and-formatting-syntax/">https://help.github.com/articles/basic-writing-and-formatting-syntax/</a>
</small>
</p>
<aside class="notes">
<p></p>
</aside>
</section>
<section>
<img src="images/github-markdown.png" />
</section>
</section>
<section>
<section>
<h1>Pull Request</h1>
<p>Contributing / Reviewing / Commenting / Accepting</p>
</section>
<section>
<img src="images/github-pullrequest.png" />
</section>
</section>
<section>
<section>
<h1>GitHub Pages</h1>
<p>Hosting static/client website (html,css, javascript)</p>
<p>Use branch gh-pages</p>
</section>
<section>
<ul>
<li>Free</li>
<li>All the benefits of Git & GitHub</li>
<li>Continuous Deployment</li>
<li>Domain provide & can add any custom domain</li>
</ul>
</section>
</section>
<section>
<section>
<h1>Asking for Help</h1>
<p>This is a good thing</p>
</section>
<section>
<h2>Advice to get an answer</h2>
<ul>
<li>Be clear & concise</li>
<li>Link to your code & line</li>
<li>Include error</li>
<li>Screenshot</li>
<li>What have you tried already?</li>
</ul>
</section>
</section>
<section>
<section>
<h1>Conclusion</h1>
<p>Do Open Source!</p>
<p>One negative, you might not enjoy your closed source projects anymore</p>
<p>
<small>
Slides written in html, css with @revealjs and hosted with <b>GitHub Pages</b>
</small>
</p>
<aside class="notes">
<p></p>
</aside>
</section>
</section>
</div>
</div>
<script src="lib/js/head.min.js"></script>
<script src="js/reveal.js"></script>
<script>
// Full list of configuration options available at:
// https://github.com/hakimel/reveal.js#configuration
Reveal.initialize({
controls: true,
progress: true,
history: true,
center: true,
transition: 'cube', // none/fade/slide/convex/concave/zoom
// Optional reveal.js plugins
dependencies: [
{ src: 'lib/js/classList.js', condition: function() { return !document.body.classList; } },
{ src: 'plugin/markdown/marked.js', condition: function() { return !!document.querySelector( '[data-markdown]' ); } },
{ src: 'plugin/markdown/markdown.js', condition: function() { return !!document.querySelector( '[data-markdown]' ); } },
{ src: 'plugin/highlight/highlight.js', async: true, callback: function() { hljs.initHighlightingOnLoad(); } },
{ src: 'plugin/zoom-js/zoom.js', async: true },
{ src: 'plugin/notes/notes.js', async: true }
]
});
</script>
</body>
</html>
Raw
LICENSE
The MIT License (MIT)
Copyright (c) 2016 AcornHack
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment