Skip to content

Commit 9c447b8

Browse files
gvwilsongvwilson
committed
Preparing for June 2016 release
1 parent 15331a0 commit 9c447b8

Some content is hidden

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

69 files changed

+3344
-14700
lines changed

‎.gitignore

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
*~
2+
.DS_Store
3+
.sass-cache
4+
_site
5+
__pycache__

‎CONDUCT.md

+44
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
---
2+
layout: page
3+
title: "Contributor Code of Conduct"
4+
permalink: /conduct/
5+
---
6+
As contributors and maintainers of this project,
7+
we pledge to respect all people who contribute through reporting issues,
8+
posting feature requests,
9+
updating documentation,
10+
submitting pull requests or patches,
11+
and other activities.
12+
13+
We are committed to making participation in this project a harassment-free experience for everyone,
14+
regardless of level of experience,
15+
gender,
16+
gender identity and expression,
17+
sexual orientation,
18+
disability,
19+
personal appearance,
20+
body size,
21+
race,
22+
ethnicity,
23+
age,
24+
or religion.
25+
26+
Examples of unacceptable behavior by participants include the use of sexual language or imagery,
27+
derogatory comments or personal attacks,
28+
trolling,
29+
public or private harassment,
30+
insults,
31+
or other unprofessional conduct.
32+
33+
Project maintainers have the right and responsibility to remove, edit, or reject
34+
comments, commits, code, wiki edits, issues, and other contributions
35+
that are not aligned to this Code of Conduct.
36+
Project maintainers who do not follow the Code of Conduct may be removed from the project team.
37+
38+
Instances of abusive, harassing, or otherwise unacceptable behavior
39+
may be reported by opening an issue or contacting one or more of the project maintainers.
40+
41+
This Code of Conduct is adapted from
42+
the [Contributor Covenant][contrib-covenant] Version 1.0.0.
43+
44+
[contrib-covenant]: http://contributor-covenant.org/

‎LICENSE.md

+83
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,83 @@
1+
---
2+
layout: page
3+
title: "Licenses"
4+
permalink: /license/
5+
---
6+
## Instructional Material
7+
8+
All Software Carpentry and Data Carpentry instructional material is
9+
made available under the [Creative Commons Attribution
10+
license][cc-by-human]. The following is a human-readable summary of
11+
(and not a substitute for) the [full legal text of the CC BY 4.0
12+
license][cc-by-legal].
13+
14+
You are free:
15+
16+
* to **Share**---copy and redistribute the material in any medium or format
17+
* to **Adapt**---remix, transform, and build upon the material
18+
19+
for any purpose, even commercially.
20+
21+
The licensor cannot revoke these freedoms as long as you follow the
22+
license terms.
23+
24+
Under the following terms:
25+
26+
* **Attribution**---You must give appropriate credit (mentioning that
27+
your work is derived from work that is Copyright © Software
28+
Carpentry and, where practical, linking to
29+
http://software-carpentry.org/), provide a [link to the
30+
license][cc-by-human], and indicate if changes were made. You may do
31+
so in any reasonable manner, but not in any way that suggests the
32+
licensor endorses you or your use.
33+
34+
**No additional restrictions**---You may not apply legal terms or
35+
technological measures that legally restrict others from doing
36+
anything the license permits. With the understanding that:
37+
38+
Notices:
39+
40+
* You do not have to comply with the license for elements of the
41+
material in the public domain or where your use is permitted by an
42+
applicable exception or limitation.
43+
* No warranties are given. The license may not give you all of the
44+
permissions necessary for your intended use. For example, other
45+
rights such as publicity, privacy, or moral rights may limit how you
46+
use the material.
47+
48+
## Software
49+
50+
Except where otherwise noted, the example programs and other software
51+
provided by Software Carpentry and Data Carpentry are made available under the
52+
[OSI][osi]-approved
53+
[MIT license][mit-license].
54+
55+
Permission is hereby granted, free of charge, to any person obtaining
56+
a copy of this software and associated documentation files (the
57+
"Software"), to deal in the Software without restriction, including
58+
without limitation the rights to use, copy, modify, merge, publish,
59+
distribute, sublicense, and/or sell copies of the Software, and to
60+
permit persons to whom the Software is furnished to do so, subject to
61+
the following conditions:
62+
63+
The above copyright notice and this permission notice shall be
64+
included in all copies or substantial portions of the Software.
65+
66+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
67+
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
68+
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
69+
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
70+
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
71+
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
72+
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
73+
74+
## Trademark
75+
76+
"Software Carpentry" an "Data Carpentry" and their respective logos
77+
are registered trademarks of [NumFOCUS][numfocus].
78+
79+
[cc-by-human]: https://creativecommons.org/licenses/by/4.0/
80+
[cc-by-legal]: https://creativecommons.org/licenses/by/4.0/legalcode
81+
[mit-license]: http://opensource.org/licenses/mit-license.html
82+
[numfocus]: http://numfocus.org/
83+
[osi]: http://opensource.org

‎Makefile

+92
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,92 @@
1+
## ========================================
2+
## Commands for both workshop and lesson websites.
3+
4+
# Settings
5+
MAKEFILES=Makefile $(wildcard *.mk)
6+
JEKYLL=jekyll
7+
DST=_site
8+
9+
# Controls
10+
.PHONY : commands clean files
11+
all : commands
12+
13+
## commands : show all commands.
14+
commands :
15+
@grep -h -E '^##' ${MAKEFILES} | sed -e 's/## //g'
16+
17+
## serve : run a local server.
18+
serve :
19+
${JEKYLL} serve --config _config.yml,_config_dev.yml
20+
21+
## site : build files but do not run a server.
22+
site :
23+
${JEKYLL} build --config _config.yml,_config_dev.yml
24+
25+
## figures : re-generate inclusion displaying all figures.
26+
figures :
27+
@bin/extract_figures.py -s _episodes -p bin/markdown-ast.rb > _includes/all_figures.html
28+
29+
## clean : clean up junk files.
30+
clean :
31+
@rm -rf ${DST}
32+
@rm -rf .sass-cache
33+
@rm -rf bin/__pycache__
34+
@find . -name .DS_Store -exec rm {} \;
35+
@find . -name '*~' -exec rm {} \;
36+
@find . -name '*.pyc' -exec rm {} \;
37+
38+
## ----------------------------------------
39+
## Commands specific to workshop websites.
40+
41+
.PHONY : workshop-check
42+
43+
## workshop-check : check workshop homepage.
44+
workshop-check :
45+
@bin/workshop_check.py .
46+
47+
## ----------------------------------------
48+
## Commands specific to lesson websites.
49+
50+
.PHONY : lesson-check lesson-files lesson-fixme lesson-single
51+
52+
# Lesson source files in the order they appear in the navigation menu.
53+
SRC_FILES = \
54+
index.md \
55+
CONDUCT.md \
56+
setup.md \
57+
$(wildcard _episodes/*.md) \
58+
reference.md \
59+
$(wildcard _extras/*.md) \
60+
LICENSE.md
61+
62+
# Generated lesson files in the order they appear in the navigation menu.
63+
HTML_FILES = \
64+
${DST}/index.html \
65+
${DST}/conduct/index.html \
66+
${DST}/setup/index.html \
67+
$(patsubst _episodes/%.md,${DST}/%/index.html,$(wildcard _episodes/*.md)) \
68+
${DST}/reference/index.html \
69+
$(patsubst _extras/%.md,${DST}/%/index.html,$(wildcard _extras/*.md)) \
70+
${DST}/license/index.html
71+
72+
## lesson-check : validate lesson Markdown.
73+
lesson-check :
74+
@bin/lesson_check.py -s . -p bin/markdown-ast.rb
75+
76+
unittest :
77+
python bin/test_lesson_check.py
78+
79+
## lesson-files : show expected names of generated files for debugging.
80+
lesson-files :
81+
@echo 'source:' ${SRC_FILES}
82+
@echo 'generated:' ${HTML_FILES}
83+
84+
## lesson-fixme : show FIXME markers embedded in source files.
85+
lesson-fixme :
86+
@fgrep -i -n FIXME ${SRC_FILES} || true
87+
88+
#-------------------------------------------------------------------------------
89+
# Include extra commands if available.
90+
#-------------------------------------------------------------------------------
91+
92+
-include commands.mk

‎_config_dev.yml

+14
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
#------------------------------------------------------------
2+
# This config-file is only needed for development. Instead of changing
3+
# the url everytime you work locally on the project, run a server with
4+
# both configuration files:
5+
#
6+
# jekyll serve --config _config.yml,_config_dev.yml
7+
#------------------------------------------------------------
8+
9+
# Is this production or development? (Overrides _config.yml.)
10+
is_production: false
11+
12+
# Override root so that CSS and other resources will load locally.
13+
github:
14+
url: http://0.0.0.0:4000

‎_episodes/.gitkeep

Whitespace-only changes.

‎_extras/.gitkeep

Whitespace-only changes.

‎_includes/all_keypoints.html

+22
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
{% comment %}
2+
Display key points of all episodes for reference.
3+
{% endcomment %}
4+
<h2>Key Points</h2>
5+
<table class="table table-striped">
6+
{% for episode in site.episodes %}
7+
{% unless episode.break %}
8+
<tr>
9+
<td class="col-md-3">
10+
<a href="{{ site.github.url }}{{ episode.url }}">{{ episode.title }}</a>
11+
</td>
12+
<td class="col-md-9">
13+
<ul>
14+
{% for keypoint in episode.keypoints %}
15+
<li>{{ keypoint }}</li>
16+
{% endfor %}
17+
</ul>
18+
</td>
19+
</tr>
20+
{% endunless %}
21+
{% endfor %}
22+
</table>

‎_includes/carpentries.html

+27
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
<div class="row">
2+
<div class="col-md-2" align="center">
3+
<a href="{{ site.swc_site }}"><img src="{{ site.github.url }}/assets/img/swc-icon-blue.svg" alt="Software Carpentry logo" /></a>
4+
</div>
5+
<div class="col-md-8">
6+
Since 1998,
7+
<a href="{{ site.swc_site }}">Software Carpentry</a>
8+
has been teaching researchers in science, engineering, medicine, and related disciplines
9+
the computing skills they need to get more done in less time and with less pain.
10+
Its volunteer instructors have run hundreds of events
11+
for thousands of learners in the past two and a half years.
12+
</div>
13+
</div>
14+
<br/>
15+
<div class="row">
16+
<div class="col-md-2" align="center">
17+
<a href="{{ site.dc_site }}"><img src="{{ site.github.url }}/assets/img/dc-icon-black.svg" alt="Data Carpentry logo" /></a>
18+
</div>
19+
<div class="col-md-8">
20+
<a href="{{ site.dc_site }}">Data Carpentry</a> develops and teaches workshops on the fundamental data skills needed to conduct research.
21+
Its target audience is researchers who have little to no prior computational experience,
22+
and its lessons are domain specific,
23+
building on learners' existing knowledge to enable them to quickly apply skills learned to their own research.
24+
</div>
25+
</div>
26+
27+

‎_includes/episode_break.html

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
{% comment %}
2+
Display information about a break.
3+
{% endcomment %}
4+
<p>Break: {{page.break}} min</p>

‎_includes/episode_find_prev_next.html

+14
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
{% comment %}
2+
Find previous and next episodes (if any).
3+
{% endcomment %}
4+
{% for episode in site.episodes %}
5+
{% if episode.url == page.url %}
6+
{% unless forloop.first %}
7+
{% assign prev_episode = prev %}
8+
{% endunless %}
9+
{% unless forloop.last %}
10+
{% assign next_episode = site.episodes[forloop.index] %}
11+
{% endunless %}
12+
{% endif %}
13+
{% assign prev = episode %}
14+
{% endfor %}

‎_includes/episode_keypoints.html

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
<blockquote class="keypoints">
2+
<h2>Key Points</h2>
3+
<ul>
4+
{% for keypoint in page.keypoints %}
5+
<li>{{ keypoint }}</li>
6+
{% endfor %}
7+
</ul>
8+
</blockquote>

‎_includes/episode_overview.html

+36
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
{% comment %}
2+
Display an episode's timings and learning objectives.
3+
{% endcomment %}
4+
<blockquote class="objectives">
5+
<h2>Overview</h2>
6+
7+
<div class="row">
8+
<div class="col-md-3">
9+
<strong>Teaching:</strong> {{ page.teaching }} min
10+
</br>
11+
<strong>Exercises:</strong> {{ page.exercises }} min
12+
</div>
13+
<div class="col-md-9">
14+
<strong>Questions</strong>
15+
<ul>
16+
{% for question in page.questions %}
17+
<li>{{ question }}</li>
18+
{% endfor %}
19+
</ul>
20+
</div>
21+
</div>
22+
23+
<div class="row">
24+
<div class="col-md-3">
25+
</div>
26+
<div class="col-md-9">
27+
<strong>Objectives</strong>
28+
<ul>
29+
{% for objective in page.objectives %}
30+
<li>{{ objective }}</li>
31+
{% endfor %}
32+
</ul>
33+
</div>
34+
</div>
35+
36+
</blockquote>

‎_includes/episode_title.html

+25
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
{% include episode_find_prev_next.html %}
2+
<div class="row">
3+
<div class="col-md-1">
4+
<h3>
5+
{% if prev_episode %}
6+
<a href="{{ site.github.url }}{{ prev_episode.url }}"><span class="glyphicon glyphicon-menu-left"></span></a>
7+
{% else %}
8+
<a href="{{ site.github.url }}"><span class="glyphicon glyphicon-menu-up"></span></a>
9+
{% endif %}
10+
</h3>
11+
</div>
12+
<div class="col-md-10">
13+
<h3 class="maintitle"><a href="{{ site.github.url }}/">{{ site.title }}</a></h3>
14+
<h1 class="maintitle">{{ page.title }}</h1>
15+
</div>
16+
<div class="col-md-1">
17+
<h3>
18+
{% if next_episode %}
19+
<a href="{{ site.github.url }}{{ next_episode.url }}"><span class="glyphicon glyphicon-menu-right"></span></a>
20+
{% else %}
21+
<a href="{{ site.github.url }}"><span class="glyphicon glyphicon-menu-up"></span></a>
22+
{% endif %}
23+
</h3>
24+
</div>
25+
</div>

0 commit comments

Comments
 (0)