Skip to content

Commit 792d2ca

Browse files
tracyktealtracykteal
committed
added config files
1 parent 07e7d9f commit 792d2ca

13 files changed

+353
-0
lines changed

‎AUTHORS

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
FIXME: list authors' names and email addresses.

‎CITATION

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
FIXME: describe how to cite this lesson.

‎CONTRIBUTING.md

Lines changed: 151 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,151 @@
1+
# Contributing
2+
3+
[Software Carpentry][swc-site] and [Data Carpentry][dc-site] are open source projects,
4+
and we welcome contributions of all kinds:
5+
new lessons,
6+
fixes to existing material,
7+
bug reports,
8+
and reviews of proposed changes are all welcome.
9+
10+
## Contributor Agreement
11+
12+
By contributing,
13+
you agree that we may redistribute your work under [our license](LICENSE.md).
14+
In exchange,
15+
we will address your issues and/or assess your change proposal as promptly as we can,
16+
and help you become a member of our community.
17+
Everyone involved in [Software Carpentry][swc-site] and [Data Carpentry][dc-site]
18+
agrees to abide by our [code of conduct](CONDUCT.md).
19+
20+
## How to Contribute
21+
22+
The easiest way to get started is to file an issue
23+
to tell us about a spelling mistake,
24+
some awkward wording,
25+
or a factual error.
26+
This is a good way to introduce yourself
27+
and to meet some of our community members.
28+
29+
1. If you do not have a [GitHub][github] account,
30+
you can [send us comments by email][email].
31+
However,
32+
we will be able to respond more quickly if you use one of the other methods described below.
33+
34+
2. If you have a [GitHub][github] account,
35+
or are willing to [create one][github-join],
36+
but do not know how to use Git,
37+
you can report problems or suggest improvements by [creating an issue][issues].
38+
This allows us to assign the item to someone
39+
and to respond to it in a threaded discussion.
40+
41+
3. If you are comfortable with Git,
42+
and would like to add or change material,
43+
you can submit a pull request (PR).
44+
Instructions for doing this are [included below](#using-github).
45+
46+
## Where to Contribute
47+
48+
1. If you wish to change this lesson,
49+
please work in <https://github.com/swcarpentry/FIXME>,
50+
which can be viewed at <https://swcarpentry.github.io/FIXME>.
51+
52+
2. If you wish to change the example lesson,
53+
please work in <https://github.com/swcarpentry/lesson-example>,
54+
which documents the format of our lessons
55+
and can be viewed at <https://swcarpentry.github.io/lesson-example>.
56+
57+
3. If you wish to change the template used for workshop websites,
58+
please work in <https://github.com/swcarpentry/workshop-template>.
59+
The home page of that repository explains how to set up workshop websites,
60+
while the extra pages in <https://swcarpentry.github.io/workshop-template>
61+
provide more background on our design choices.
62+
63+
4. If you wish to change CSS style files, tools,
64+
or HTML boilerplate for lessons or workshops stored in `_includes` or `_layouts`,
65+
please work in <https://github.com/swcarpentry/styles>.
66+
67+
## What to Contribute
68+
69+
There are many ways to contribute,
70+
from writing new exercises and improving existing ones
71+
to updating or filling in the documentation
72+
and and submitting [bug reports][issues]
73+
about things that don't work, aren't clear, or are missing.
74+
If you are looking for ideas,
75+
please see [the list of issues for this repository][issues],
76+
or the issues for [Data Carpentry][dc-issues]
77+
and [Software Carpentry][swc-issues] projects.
78+
79+
Comments on issues and reviews of pull requests are just as welcome:
80+
we are smarter together than we are on our own.
81+
Reviews from novices and newcomers are particularly valuable:
82+
it's easy for people who have been using these lessons for a while
83+
to forget how impenetrable some of this material can be,
84+
so fresh eyes are always welcome.
85+
86+
## What *Not* to Contribute
87+
88+
Our lessons already contain more material than we can cover in a typical workshop,
89+
so we are usually *not* looking for more concepts or tools to add to them.
90+
As a rule,
91+
if you want to introduce a new idea,
92+
you must (a) estimate how long it will take to teach
93+
and (b) explain what you would take out to make room for it.
94+
The first encourages contributors to be honest about requirements;
95+
the second, to think hard about priorities.
96+
97+
We are also not looking for exercises or other material that only run on one platform.
98+
Our workshops typically contain a mixture of Windows, Mac OS X, and Linux users;
99+
in order to be usable,
100+
our lessons must run equally well on all three.
101+
102+
## Using GitHub
103+
104+
If you choose to contribute via GitHub,
105+
you may want to look at
106+
[How to Contribute to an Open Source Project on GitHub][how-contribute].
107+
In brief:
108+
109+
1. The published copy of the lesson is in the `gh-pages` branch of the repository
110+
(so that GitHub will regenerate it automatically).
111+
Please create all branches from that,
112+
and merge the [master repository][repo]'s `gh-pages` branch into your `gh-pages` branch
113+
before starting work.
114+
Please do *not* work directly in your `gh-pages` branch,
115+
since that will make it difficult for you to work on other contributions.
116+
117+
2. We use [GitHub flow][github-flow] to manage changes:
118+
1. Create a new branch in your desktop copy of this repository for each significant change.
119+
2. Commit the change in that branch.
120+
3. Push that branch to your fork of this repository on GitHub.
121+
4. Submit a pull request from that branch to the [master repository][repo].
122+
5. If you receive feedback,
123+
make changes on your desktop and push to your branch on GitHub:
124+
the pull request will update automatically.
125+
126+
Each lesson has two maintainers who review issues and pull requests
127+
or encourage others to do so.
128+
The maintainers are community volunteers,
129+
and have final say over what gets merged into the lesson.
130+
131+
## Other Resources
132+
133+
General discussion of [Software Carpentry][swc-site] and [Data Carpentry][dc-site]
134+
happens on the [discussion mailing list][discuss-list],
135+
which everyone is welcome to join.
136+
You can also [reach us by email][email].
137+
138+
[email]: mailto:[email protected]
139+
[dc-issues]: https://github.com/issues?q=user%3Adatacarpentry
140+
[dc-lessons]: http://datacarpentry.org/lessons/
141+
[dc-site]: http://datacarpentry.org/
142+
[discuss-list]: http://lists.software-carpentry.org/listinfo/discuss
143+
[github]: https://github.com
144+
[github-flow]: https://guides.github.com/introduction/flow/
145+
[github-join]: https://github.com/join
146+
[how-contribute]: https://egghead.io/series/how-to-contribute-to-an-open-source-project-on-github
147+
[issues]: https://github.com/swcarpentry/FIXME/issues/
148+
[repo]: https://github.com/swcarpentry/FIXME/
149+
[swc-issues]: https://github.com/issues?q=user%3Aswcarpentry
150+
[swc-lessons]: https://software-carpentry.org/lessons/
151+
[swc-site]: https://software-carpentry.org/

‎_config.yml

Lines changed: 74 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,74 @@
1+
#------------------------------------------------------------
2+
# Values for this lesson.
3+
#------------------------------------------------------------
4+
5+
# Which carpentry is this ("swc", "dc", or "lc")?
6+
carpentry: "swc"
7+
8+
# Overall title for pages.
9+
title: "Lesson Title"
10+
11+
# Contact. This *must* include the protocol: if it's an email
12+
# address, it must look like "mailto:[email protected]",
13+
# or if it's a URL, "https://gitter.im/username/ProjectName".
14+
email: "mailto:[email protected]"
15+
16+
#------------------------------------------------------------
17+
# Generic settings (should not need to change).
18+
#------------------------------------------------------------
19+
20+
# What kind of thing is this ("workshop" or "lesson")?
21+
kind: "lesson"
22+
23+
# Magic to make URLs resolve both locally and on GitHub.
24+
# See https://help.github.com/articles/repository-metadata-on-github-pages/.
25+
repository: <USERNAME>/<PROJECT>
26+
27+
# Sites.
28+
amy_site: "https://amy.software-carpentry.org/workshops"
29+
dc_site: "http://datacarpentry.org"
30+
swc_github: "https://github.com/swcarpentry"
31+
swc_site: "https://software-carpentry.org"
32+
swc_pages: "https://swcarpentry.github.io"
33+
lc_site: "https://librarycarpentry.github.io/"
34+
template_repo: "https://github.com/swcarpentry/styles"
35+
example_repo: "https://github.com/swcarpentry/lesson-example"
36+
example_site: "https://swcarpentry.github.com/lesson-example"
37+
workshop_repo: "https://github.com/swcarpentry/workshop-template"
38+
workshop_site: "https://swcarpentry.github.io/workshop-template"
39+
training_site: "https://swcarpentry.github.io/instructor-training"
40+
41+
# Surveys.
42+
pre_survey: "https://www.surveymonkey.com/r/swc_pre_workshop_v1?workshop_id="
43+
post_survey: "https://www.surveymonkey.com/r/swc_post_workshop_v1?workshop_id="
44+
training_post_survey: "https://www.surveymonkey.com/r/post-instructor-training"
45+
46+
# Start time in minutes (0 to be clock-independent, 540 to show a start at 09:00 am).
47+
start_time: 0
48+
49+
# Specify that things in the episodes collection should be output.
50+
collections:
51+
episodes:
52+
output: true
53+
permalink: /:path/index.html
54+
extras:
55+
output: true
56+
permalink: /:path/index.html
57+
58+
# Set the default layout for things in the episodes collection.
59+
defaults:
60+
- values:
61+
root: ..
62+
- scope:
63+
path: ""
64+
type: episodes
65+
values:
66+
layout: episode
67+
68+
# Files and directories that are not to be copied.
69+
exclude:
70+
- Makefile
71+
- bin
72+
73+
# Turn on built-in syntax highlighting.
74+
highlighter: rouge

‎_episodes/01-introduction.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
---
2+
title: "Introduction"
3+
teaching: 0
4+
exercises: 0
5+
questions:
6+
- "Key question"
7+
objectives:
8+
- "First objective."
9+
keypoints:
10+
- "First key point."
11+
---

‎_extras/about.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
layout: page
3+
title: About
4+
---
5+
{% include carpentries.html %}

‎_extras/discuss.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
layout: page
3+
title: Discussion
4+
---
5+
FIXME

‎_extras/figures.md

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
---
2+
layout: page
3+
title: Figures
4+
---
5+
<script>
6+
window.onload = function() {
7+
var lesson_episodes = [
8+
{% for episode in site.episodes %}
9+
"{{ episode.url}}"{% unless forloop.last %},{% endunless %}
10+
{% endfor %}
11+
];
12+
var xmlHttp = []; /* Required since we are going to query every episode. */
13+
for (i=0; i < lesson_episodes.length; i++) {
14+
xmlHttp[i] = new XMLHttpRequest();
15+
xmlHttp[i].episode = lesson_episodes[i]; /* To enable use this later. */
16+
xmlHttp[i].onreadystatechange = function() {
17+
if (this.readyState == 4 && this.status == 200) {
18+
var article_here = document.getElementById(this.episode);
19+
var parser = new DOMParser();
20+
var htmlDoc = parser.parseFromString(this.responseText,"text/html");
21+
var htmlDocArticle = htmlDoc.getElementsByTagName("article")[0];
22+
article_here.appendChild(htmlDocArticle.getElementsByTagName("h1")[0]);
23+
for (let image of htmlDocArticle.getElementsByTagName("img")) {
24+
article_here.appendChild(image);
25+
}
26+
}
27+
}
28+
episode_url = "{{ page.root }}" + lesson_episodes[i];
29+
xmlHttp[i].open("GET", episode_url);
30+
xmlHttp[i].send(null);
31+
}
32+
}
33+
</script>
34+
{% comment %}
35+
Create anchor for each one of the episodes.
36+
{% endcomment %}
37+
{% for episode in site.episodes %}
38+
<article id="{{ episode.url }}"></article>
39+
{% endfor %}

‎_extras/guide.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
layout: page
3+
title: "Instructor Notes"
4+
---
5+
FIXME

‎aio.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
---
2+
layout: page
3+
root: .
4+
---
5+
<script>
6+
window.onload = function() {
7+
var lesson_episodes = [
8+
{% for episode in site.episodes %}
9+
"{{ episode.url}}"{% unless forloop.last %},{% endunless %}
10+
{% endfor %}
11+
];
12+
var xmlHttp = []; /* Required since we are going to query every episode. */
13+
for (i=0; i < lesson_episodes.length; i++) {
14+
xmlHttp[i] = new XMLHttpRequest();
15+
xmlHttp[i].episode = lesson_episodes[i]; /* To enable use this later. */
16+
xmlHttp[i].onreadystatechange = function() {
17+
if (this.readyState == 4 && this.status == 200) {
18+
var article_here = document.getElementById(this.episode);
19+
var parser = new DOMParser();
20+
var htmlDoc = parser.parseFromString(this.responseText,"text/html");
21+
var htmlDocArticle = htmlDoc.getElementsByTagName("article")[0];
22+
article_here.innerHTML = htmlDocArticle.innerHTML;
23+
}
24+
}
25+
episode_url = "{{ page.root }}" + lesson_episodes[i];
26+
xmlHttp[i].open("GET", episode_url);
27+
xmlHttp[i].send(null);
28+
}
29+
}
30+
</script>
31+
{% comment %}
32+
Create anchor for each one of the episodes.
33+
{% endcomment %}
34+
{% for episode in site.episodes %}
35+
<article id="{{ episode.url }}"></article>
36+
{% endfor %}

‎index.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
---
2+
layout: lesson
3+
root: .
4+
permalink: index.html # Is the only page that don't follow the partner /:path/index.html
5+
---
6+
FIXME: home page introduction
7+
8+
> ## Prerequisites
9+
>
10+
> FIXME
11+
{: .prereq}

‎reference.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
---
2+
layout: reference
3+
root: .
4+
---
5+
6+
## Glossary
7+
8+
FIXME

‎setup.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
layout: page
3+
title: Setup
4+
root: .
5+
---
6+
FIXME

0 commit comments

Comments
 (0)