Skip to content

Commit 0712187

Browse files
author
Jordan McCullough
committed
Merge pull request #287 from github/no-more-includes-for-slides
Deprecate `include` for all slide panels in decks
2 parents 7ce2b4a + c3886e2 commit 0712187

File tree

10 files changed

+976
-268
lines changed

10 files changed

+976
-268
lines changed

README.md

Lines changed: 15 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -14,17 +14,27 @@ We know that many of the users of this repository are just focused on getting th
1414

1515
## Contribute
1616

17-
We’re eager to have your help in improving this kit. If you have an idea for a change, start by opening a new [Issue](https://github.com/github/training-kit/issues) so we can discuss and help guide your contribution to the right location. If you have corrections or kit contributions, we'd be glad to receive them via a [Pull Request](https://help.github.com/articles/using-pull-requests). For kit contributions, we ask you to share in our mindset of minimalism. We aim to keep the workbook and slides a synchronized pair.
17+
We’re eager to have your help in improving this kit. If you have an idea for a change, start by opening a new [Issue](https://github.com/github/training-kit/issues) so we can discuss and help guide your contribution to the right location. If you have corrections or kit contributions, we'd be glad to receive them via a [Pull Request](https://help.github.com/articles/using-pull-requests). For kit contributions, we ask you to share in our mindset of minimalism.
1818

19-
The educational content exists in two top level directories:
19+
The slides align with the [Foundations](), [Intermediate](), and [Advanced]() classes delivered by the GitHub Training team.
2020

21-
1. [`slides`](https://github.com/github/training-kit/tree/master/slides)
22-
2. [`workbooks`](https://github.com/github/training-kit/tree/master/workbooks)
21+
The three class' slides reside at top-level directories:
22+
23+
- [`foundations/`](https://github.com/github/training-kit/tree/master/foundations)
24+
- [`intermediate/`](https://github.com/github/training-kit/tree/master/intermediate)
25+
- [`advanced/`](https://github.com/github/training-kit/tree/master/advanced)
2326

2427

2528
## File Format
2629

27-
The majority of the site materials are written in [Markdown](http://whatismarkdown.com), a [lightweight markup language](http://en.wikipedia.org/wiki/Lightweight_markup_language) supported in the GitHub web application user interface. There is a syntax guide to the original [Markdown format](http://daringfireball.net/projects/markdown/syntax) and also [GitHub Flavored Markdown](http://github.github.com/github-flavored-markdown/). This repository is based on [Hydeslides](https://github.com/jordanmccullough/HydeSlides). That project offers additional information on the file and directory structure.
30+
The class materials are written in [Markdown](http://whatismarkdown.com), a [lightweight markup language](http://en.wikipedia.org/wiki/Lightweight_markup_language) supported in the GitHub web application user interface. There is a syntax guide to the original [Markdown format](http://daringfireball.net/projects/markdown/syntax) and also [GitHub Flavored Markdown](http://github.github.com/github-flavored-markdown/).
31+
32+
The class material content possess two specialized uses of Markdown for slide-like rendering and formatting:
33+
34+
- Full-screen slides are preceded with a `---` and followed by `---`
35+
- Step-by-step *lab* sections are wrapped with `{% capture lab %}` and `{% endcapture %}{% include lab %}`
36+
37+
This repository is based on [Hydeslides](https://github.com/jordanmccullough/HydeSlides). That project offers additional information on the file and directory structure.
2838

2939
## Build
3040

_includes/slide-section

Lines changed: 0 additions & 6 deletions
This file was deleted.

_includes/svg

Lines changed: 0 additions & 9 deletions
This file was deleted.

_javascript/curriculum.js

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -131,9 +131,14 @@ $(function(){
131131
});
132132

133133
function updateSlideSize(){
134-
var w = window.innerWidth;
135-
var h = window.innerHeight;
136-
$(".slide").css("height", h);
134+
var h = window.innerHeight,
135+
even = $("hr:even");
136+
137+
even.each(function(index){
138+
$(this).nextUntil("hr").wrapAll("<div class='slide'><div class='alignment'></div>");
139+
});
140+
141+
$(".slide").css("height", h + "px");
137142
}
138143

139144
//Time toggle keybinding

_stylesheets/curriculum.scss

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -246,6 +246,9 @@ table{
246246
opacity: .5;
247247
}
248248

249+
&>hr{
250+
display: none;
251+
}
249252

250253
.slide{
251254
width: 100%;

advanced/index.md

Lines changed: 76 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -6,17 +6,23 @@ redirect_from:
66
- ../workbooks/github-advanced.html
77
---
88

9-
{% capture slide %}
9+
---
10+
1011
## Understanding Git, navigating history
11-
{% endcapture %}{% include slide-section %}
1212

13-
{% capture slide %}
13+
---
14+
15+
---
16+
1417
![Git data structure](../assets/diagrams/commit-data-structure.svg)
15-
{% endcapture %}{% include slide-section %}
1618

17-
{% capture slide %}
19+
---
20+
21+
---
22+
1823
![Commit DAG](../assets/diagrams/commit-dag.svg)
19-
{% endcapture %}{% include slide-section %}
24+
25+
---
2026

2127
{% capture lab %}
2228
1. Understand the way Git preserves history and data objects
@@ -82,9 +88,11 @@ $ git log --oneline --left-right master...other
8288
<iframe src="//player.vimeo.com/video/95811891" width="500" height="350" frameborder="0" webkitallowfullscreen mozallowfullscreen allowfullscreen></iframe>
8389

8490

85-
{% capture slide %}
91+
---
92+
8693
## Collaborating on change & releases
87-
{% endcapture %}{% include slide-section %}
94+
95+
---
8896

8997
{% capture lab %}
9098
1. Utilize the command line for branching strategies
@@ -158,9 +166,11 @@ $ git push origin :[tag-name-to-delete]
158166

159167

160168

161-
{% capture slide %}
169+
---
170+
162171
## Ignoring & cleaning up files
163-
{% endcapture %}{% include slide-section %}
172+
173+
---
164174

165175
{% capture lab %}
166176
1. Setup ignore patterns to prevent accidental versioning
@@ -209,9 +219,11 @@ $ git clean -fx
209219
### Video
210220
<iframe src="//player.vimeo.com/video/99804597" width="500" height="350" frameborder="0" webkitallowfullscreen mozallowfullscreen allowfullscreen></iframe>
211221

212-
{% capture slide %}
222+
---
223+
213224
## Mastering shortcuts & efficiencies
214-
{% endcapture %}{% include slide-section %}
225+
226+
---
215227

216228
{% capture lab %}
217229
1. Use built-in, time-saving command shortcuts for committing and branch switching
@@ -283,9 +295,11 @@ $ git config rerere.enable true
283295

284296

285297

286-
{% capture slide %}
298+
---
299+
287300
## Capturing pieces of history
288-
{% endcapture %}{% include slide-section %}
301+
302+
---
289303

290304
{% capture lab %}
291305
1. Capture select commits and generate new history on separate branches
@@ -313,30 +327,42 @@ git checkout [commit] -- [path]
313327

314328

315329

316-
{% capture slide %}
330+
---
331+
317332
## Rewriting and crafting history
318-
{% endcapture %}{% include slide-section %}
319333

320-
{% capture slide %}
334+
---
335+
336+
---
337+
321338
![Rebase](../assets/diagrams/rebase-01.svg)
322-
{% endcapture %}{% include slide-section %}
323339

324-
{% capture slide %}
340+
---
341+
342+
---
343+
325344
![Rebase](../assets/diagrams/rebase-02.svg)
326-
{% endcapture %}{% include slide-section %}
327345

328-
{% capture slide %}
346+
---
347+
348+
---
349+
329350
![Rebase](../assets/diagrams/rebase-03.svg)
330-
{% endcapture %}{% include slide-section %}
331351

352+
---
353+
354+
355+
---
332356

333-
{% capture slide %}
334357
![Rebase](../assets/diagrams/rebase-interactive-01.svg)
335-
{% endcapture %}{% include slide-section %}
336358

337-
{% capture slide %}
359+
---
360+
361+
---
362+
338363
![Rebase](../assets/diagrams/rebase-interactive-02.svg)
339-
{% endcapture %}{% include slide-section %}
364+
365+
---
340366

341367

342368
{% capture lab %}
@@ -396,9 +422,11 @@ $ git rebase -i --autosquash [ref]
396422

397423

398424

399-
{% capture slide %}
425+
---
426+
400427
## Reviewing & synchronizing
401-
{% endcapture %}{% include slide-section %}
428+
429+
---
402430

403431
{% capture lab %}
404432
1. Review GitHub pull requests from the command line
@@ -479,9 +507,11 @@ $ git config --add remote.[upstream].fetch "+refs/pull/*/head:refs/remotes/[upst
479507

480508

481509

482-
{% capture slide %}
510+
---
511+
483512
## Filtering histories & externalizing dependencies
484-
{% endcapture %}{% include slide-section %}
513+
514+
---
485515

486516
{% capture lab %}
487517
1. Separate versioned content in a repository into a separate one
@@ -524,9 +554,11 @@ $ git submodule update --init --recursive
524554

525555

526556

527-
{% capture slide %}
557+
---
558+
528559
## Signing work
529-
{% endcapture %}{% include slide-section %}
560+
561+
---
530562

531563
{% capture lab %}
532564
1. Use a GPG key to sign a specific commit
@@ -571,9 +603,11 @@ $ git tag -v [tag-name]
571603
572604
573605
574-
{% capture slide %}
606+
---
607+
575608
## Using GitHub CLI and the API
576-
{% endcapture %}{% include slide-section %}
609+
610+
---
577611
578612
{% capture lab %}
579613
1. Create a GitHub (public or private) repository from the command line
@@ -625,9 +659,11 @@ $ curl -n <URL>
625659
There are a number of libraries for interfacing with the GitHub API, all of which are available at [octokit.github.io](http://octokit.github.io/)
626660
627661
628-
{% capture slide %}
662+
---
663+
629664
## Diff & merge tool
630-
{% endcapture %}{% include slide-section %}
665+
666+
---
631667
632668
{% capture lab %}
633669
1. Setup a preferred visual tool for diff and merge operations
@@ -690,9 +726,11 @@ A sample `.gitconfig` file:
690726
691727
692728
693-
{% capture slide %}
729+
---
730+
694731
## Additional resources
695-
{% endcapture %}{% include slide-section %}
732+
733+
---
696734
697735
### Details
698736
This course covers many advanced uses of Git and GitHub, and yet there is still more to explore. We've included some of the most useful resources for our students with insatiable appetites.

0 commit comments

Comments
 (0)