Skip to content

Commit e3a368d

Browse files
authored
add github training
1 parent 918b578 commit e3a368d

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

43 files changed

+392
-2
lines changed

.gitignore

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
2+
.DS_Store

README.md

+16-2
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,23 @@
1-
# Creating Open Source Informatics Instructional Resources
1+
# Creating Open Source Informatics Instructional Resources
22

3-
This repository contains all materials for the 2022 LIEAF workshop on **Creating Open Source Informatics Instrctuional Resources**.
3+
This repository contains all materials for the 2022 LIEAF workshop on **Creating Open Source Informatics Instructional Resources**.
44

55
The live presentation of this workshop is November 8th at the AMIA 2022 Linking Informatics and Education Academic Forum Conference (LIEAF).
66

7+
Main topic sections include:
8+
9+
* Working with GitHub
10+
* Writing markdown
11+
* Presenting with LiaScript
12+
13+
## Contents
14+
15+
* Working with GitHub:
16+
17+
- [Slide Deck](https://liascript.github.io/course/?https://raw.githubusercontent.com/arcus/LIEAF2022_workshop/main/github_slides.md)
18+
- [Speaker notes](https://liascript.github.io/course/?https://raw.githubusercontent.com/arcus/LIEAF2022_workshop/main/github_speaker_notes.md)
19+
20+
721
## Important Links
822
- [LiaScript](https://liascript.github.io)
923
- This page [on GitHub](https://github.com/arcus/LIEAF2022_workshop/blob/main/README.md)

github_slides.md

+141
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,141 @@
1+
<!--
2+
title: GitHub
3+
mode: Presentation
4+
-->
5+
6+
## Today's Itinerary
7+
8+
* GitHub: Creating a place for your files
9+
* Markdown: Making documentation readable
10+
* Liascript: Making documentation beautiful and interactive
11+
12+
## GitHub
13+
14+
* Logging in
15+
* Creating a new repository (repo)
16+
* Forking an existing repo
17+
18+
### Logging into GitHub
19+
20+
First step: go to [https://github.com](https://github.com) and either:
21+
22+
* Login (if you have an account)
23+
* Create an account (it's free!)
24+
25+
#### Your Account Homepage
26+
27+
![](media/github_account_home.png)<!-- style = "max-width:800px; border: 1px solid;" -->
28+
29+
30+
#### Version Control
31+
32+
Primitive Version Control (look familiar?)
33+
34+
![](media/primitive_version_control.png)<!-- style = "max-width:600px; border: 1px solid;" -->
35+
36+
#### Git Version Control
37+
38+
Git Version Control:
39+
40+
![](media/git_commits.png)<!-- style = "max-width:800px; border: 1px solid;" -->
41+
42+
#### Text Files: Git's Specialty
43+
44+
Text files:
45+
46+
* .txt files
47+
* Computer code
48+
* Configuration files
49+
* Plain text data (.json, .csv)
50+
* Markup/Markdown (.xml, .yaml, .md)
51+
* Anything that is encoded as plain text
52+
53+
Not text files:
54+
55+
* Microsoft Word
56+
* .pdfs
57+
* image files
58+
* PowerPoint
59+
* Anything that if you open it in a text editor looks like scrambled nonsense
60+
61+
#### Git ≠ GitHub
62+
63+
![](media/git_logo.png)<!-- style = "max-width: 150px;" -->
64+
65+
**is not**
66+
67+
![](media/github_logo.png)<!-- style = "max-width: 200px;"-->
68+
69+
GitHub represents git processes in a nicer-looking way and adds its own bells and whistles. It's not the only company or website that works really well with git!
70+
71+
### Creating a Repository in GitHub
72+
73+
![](media/new_repository_button.png)<!-- style = "max-width:200px; border: 1px solid;" -->
74+
![](media/new_repository_form.png)<!-- style = "max-width:600px; border: 1px solid;" -->
75+
76+
#### Examine Repository
77+
78+
![](media/repository_view.png)<!-- style = "max-width:800px; border: 1px solid;" -->
79+
80+
#### README.md Example 1
81+
82+
![](media/education_modules_readme.png)<!-- style = "max-width:800px;" -->
83+
84+
#### README.md Example 2
85+
86+
![](media/intro_to_r_readme.png)<!-- style = "max-width:800px; border: 1px solid;" -->
87+
88+
#### Updating Your Repository: First Method
89+
90+
![](media/pencil_icon.png)<!-- style = "max-width:400px; border: 1px solid;" -->
91+
![](media/github_editor.png)<!-- style = "max-width:600px; border: 1px solid;" -->
92+
93+
#### Edit and Preview: First Method
94+
95+
![](media/edit_preview.png)<!-- style = "max-width:900px;" -->
96+
97+
#### Saving Files and Committing: First Method
98+
99+
![](media/commit_message.png)<!-- style = "max-width:10 00px;" -->
100+
101+
#### Getting Back to Repository View
102+
103+
![](media/file_view.png)<!-- style = "max-width:800px; border: 1px solid;" -->
104+
105+
#### Adding a File: First Method
106+
107+
![](media/add_file.png)<!-- style = "max-width:400px; border: 1px solid;" -->
108+
![](media/uploader.png)<!-- style = "max-width:400px; border: 1px solid;" -->
109+
110+
#### Updating Your Repository: Second Method
111+
112+
![](media/github_dev.png)<!-- style = "max-width:500px; border: 1px solid;" -->
113+
114+
#### Edit and Preview: Second Method
115+
116+
![](media/dev_editor.png)<!-- style = "max-width:800px; border: 1px solid;" -->
117+
118+
![](media/dev_uncommitted_changes.png)<!-- style = "max-width:800px; border: 1px solid;" -->
119+
120+
#### Adding a File: Second Method
121+
122+
![](media/dev_new_file.png)<!-- style = "max-width:300px; border: 1px solid;" -->
123+
![](media/info_txt.png)<!-- style = "max-width:600px; border: 1px solid;" -->
124+
125+
#### Saving Files and Committing: Second Method
126+
127+
![](media/source_control_hover.png)<!-- style = "max-width:400px; border: 1px solid;" --> ![](media/dev_commit.png)<!-- style = "max-width:400px; border: 1px solid;" -->
128+
129+
#### Get Back to GitHub
130+
131+
To get back to your normal GitHub repository, you can either change ".dev" to ".com" in the URL, or you can click on the "burger" menu (three lines) in the upper left and choose "Go To Repository".
132+
133+
![](media/go_to_repository.png)<!-- style = "max-width:500px; border: 1px solid;" -->
134+
135+
### Forking an Existing Repository
136+
137+
![](media/pbj_fork_button.png)<!-- style = "max-width:500px; border: 1px solid;" --> ![](media/fork_form.png)<!-- style = "max-width:500px; border: 1px solid;" -->
138+
139+
#### Looking at Your Fork
140+
141+
![](media/your_fork.png)<!-- style = "max-width:500px; border: 1px solid;" -->

0 commit comments

Comments
 (0)