This repository was archived by the owner on Apr 29, 2021. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathindex.html
More file actions
245 lines (224 loc) · 11.2 KB
/
index.html
File metadata and controls
245 lines (224 loc) · 11.2 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
<!DOCTYPE html>
<html>
<head>
<title> RSE induction for Out of Our Minds </title>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link href='https://fonts.googleapis.com/css?family=Fira+Sans:400,400italic,500,500italic,700' rel='stylesheet' type='text/css'>
<link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/font-awesome/4.5.0/css/font-awesome.min.css">
<link rel="stylesheet" href="assets/css/style.css">
<link rel="icon" type="image/ico" href="https://mozillascience.org/img/favicon.ico">
<script src="https://code.jquery.com/jquery-2.1.4.min.js" type="text/javascript" charset="utf-8"></script>
<script src="assets/javascript/script.js" type="text/javascript" charset="utf-8"></script>
</head>
<body>
<aside>
<div class="image">
</div>
<nav>
<a class="selected" href="#about"> About </a>
<a href="#exercises"> Exercises</a>
<a href="#help">Help</a>
</nav>
</aside>
<article>
<div class="logo">
<a href="http://rse.shef.ac.uk" title="RSE Sheffield"
target="_blank">
<img src="assets/images/rse-sheffield-logo.png" width="400px"/>
</a>
</div>
<br/>
<h1 id='about'> RSE Induction for OOOMinders </h1>
<br>
<strong> Prepared for PDRAs and PhDs of the Out of Our Minds Project
@The University of Sheffield, October 2017.
</strong>
<h2> Welcome on board! </h2>
<div class="meta-information">
<p class="summary">
This RSE induction is aimed to introduce the attendees to
software development best practices as well as presenting a
friendly introduction to GitHub -a free and open source
platform that can help you build projects that are
collaborative, well documented, and version-controlled.
In this workshop we will introduce you to the Github ecosystem
and help you get you comfortable navigating basic Github
workflows. We will make sure that you leave the workshop
aware of the best practices for developing projects on Github
(e.g. writing a good “readme” or posting and labeling issues)
and an understanding of how Github can help make your projects
more readable and accessible.
</p>
</div>
<div class="image">
<img src="http://i.imgur.com/CfugmWx.png" alt="mozwow" height="90" width="770">
</div>
<!--Links to talks-->
<h3 id='Slides'> Slides </h3>
<p>
The link(s) to the presentation(s) can be found below.
</p>
<ol>
<li><strong><a href="http://mikecroucher.github.io/MLPM_talk/" target="_blank">
Is your research software correct?</a></strong></li>
<li><strong><a href="http://bitsandchips.me/RSE_induction/Git_intro.html"
target="blank">What, Why, and Welcome to Github</a></strong> - In this short presentation, we'll get a brief intro to what GitHub is and some handy terms which well help get you speaking the language of Git/Github. We also show some common use cases for how and why GitHub might make working on and collaborating on projects more manageable.</li>
<h2 id="exercises">Exercises</h2>
<!-- Links to handouts -->
<h3>Sessions</h3>
<p>
The links to the excercises can be found below.
</p>
<ol>
<li><a href="guides/firstrepo/" target="blank">My First Repo</a>: Make your own repository on GitHub and experiment with issues, branches,
commit messages and pull requests.</li>
<li><a href="https://try.github.io/levels/1/challenges/1" target="_blank">
https://try.github.io</a>
: Git from the command line: interactive git tutorial</li>
<li> Working locally : Add a repository from your own computer and keep it
synced with the version online at GitHub (live session)</li>
</ol>
<h2 id="help">Help</h2>
<ol class="steps">
<!-- Step 1 -->
<li>
<h1>Getting Help</h1>
<p>
Here we'll hopefully answer questions you might have.
</p>
<ul>
<li>
<h2> How can I ask questions?</h2>
<p> Please feel free to ask any of the facilitators any
questions you have - we're here to help!
<br> <br>
You should also try asking your neighbours as you're
working through the exercises. Figuring out how to do
this in pairs is much easier than struggling alone!
<br><br>
We have a living
<a href="https://etherpad.wikimedia.org/p/RSEinduction_OOOMinds" target='blank'>
Etherpad</a> where we will be collecting
any questions from participants and answering either on
a rolling basis.
<br>
Hop on the pad if you've got questions, comments,
want to make notes as we're going along, or want to
answer any of the questions.</p>
<h2> How can I get help with my software? </h2>
<p> Your main RSE for this project is Tania Allard, you
can contact her at <a href="mailto:t.allard@sheffield.ac.uk">
t.allard@sheffield.ac.uk</a>.
She shall be able to help you with your software problems
or to point you to the right person.
</p>
<h2>What if I need help on the fly when developing software?</h2>
<p>There are some awesome community resources out there
for people working on software. <a href="https://stackoverflow.com">
Stack Overflow</a> is a great place to start with, and surely
you will find loads of answers there.
</p>
</li>
</ul>
</li>
<!--Step 2-->
<li>
<h1> Centralised RSE support and resources for OOOMinds</h1>
<p>
We have set a <a href="https://github.com/ooominds"> GitHub
organisation</a>
for the project. There, we will all share the software develop
(all of it) and collaborate with others.
</p>
<ul>
<li> <h2> RSE specific repository </h2>
<a href="https://github.com/ooominds/OOOM_RSE">
https://github.com/ooominds/OOOM_RSE</a>
</li>
<li> <h2> Onboarding info: MUST read </h2>
<a href="https://github.com/ooominds/OOOM_RSE/blob/master/onboarding.md">
https://github.com/ooominds/OOOM_RSE/blob/master/onboarding.md</a>
</li>
</ul>
If you still have not been granted access to this material please
let your RSE know.
</li>
<!-- Step 3 -->
<li>
<h1> Additional resources </h1>
<p>
Here we'll list some persistent resources that you might
use throughout the workshop and on your own time.
</p>
<ul>
<li>
<h2>This induction repository</h2>
<p><a href="https://github.com/trallard/RSE_induction">
https://github.com/trallard/RSE_induction</a></p>
</li>
<li>
<h2>Markdown Cheatsheet</h2>
<p><a href=" https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet"> https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet</a></p>
</li>
<li>
<h2>GitHub help pages</h2>
<p><a href="https://help.github.com/">https://help.github.com/</a></p>
</li>
<li>
<h2>Ten simple rules for taking advantage of Git and GitHub
<a href="http://journals.plos.org/ploscompbiol/article?id=10.1371/journal.pcbi.1004947">
http://journals.plos.org/ploscompbiol/article?id=10.1371/journal.pcbi.1004947</a></h2>
</li>
<li>
<h2> Git Command Line Cheat Sheet </h2>
<a href="https://services.github.com/on-demand/downloads/github-git-cheat-sheet.pdf">
https://services.github.com/on-demand/downloads/github-git-cheat-sheet.pdf</a>
</li>
<li>
<h2>Example Project: Cookie Recipe</h2>
<p><a href="https://github.com/joeyklee/friendly-github-intro/tree/master/examples/chocolate-chip-cookies">https://github.com/joeyklee/friendly-github-intro/tree/master/examples/chocolate-chip-cookies</a></p>
</li>
<li>
<h2>Example Project: A Simple Interactive Map Using R</h2>
<p><a href="https://github.com/joeyklee/friendly-github-intro/tree/gh-pages/examples/interactive-r-map">
https://github.com/joeyklee/friendly-github-intro/tree/gh-pages/examples/interactive-r-map</a></p>
</li>
<li>
<h2>Example Project: A Portfolio Template</h2>
<p><a href="https://github.com/joeyklee/friendly-github-intro/tree/master/examples/portfolio-template">
https://github.com/joeyklee/friendly-github-intro/tree/master/examples/portfolio-template</a></p>
</li>
</ul>
</ol>
<!-- <h2 id="glossary">Glossary</h2>
<section class="glossary">
<section class="term">
<h3>Open Science</h3>
<p>
...
</p>
</section>
<section class="term">
<h3>Open Access</h3>
<p>
...
</p>
</section>
</section> -->
<!-- <h2 id="survey">Surveys</h2>
<ul>
<li>
<h3>Pre Workshop Survey</h3>
<p><a href="----">Please fill out this survey so we can have a baseline understanding of who you are and how we can tailor the workshop to your interests.</a></p>
</li>
<li>
<h3>Post Workshop Survey</h3>
<p><a href="---">Please fill out this survey so we can help make this workshop better!</a></p>
</li>
</ul> -->
</li>
</ol>
</article>
</body>
</html>