Skip to content

Commit 025ee80

Browse files
committed
De-carpentryfy the lesson look
1 parent 8bf8eaf commit 025ee80

File tree

14 files changed

+361
-0
lines changed

14 files changed

+361
-0
lines changed

.travis.yml

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
# Travis CI is only used to check the lesson and is not involved in its deployment
2+
dist: xenial # Ubuntu 16.04 (required for python 3.7)
3+
language: python
4+
python: 3.7
5+
branches:
6+
only:
7+
- gh-pages
8+
- /.*/
9+
before_install:
10+
- sudo apt-key adv --keyserver keyserver.ubuntu.com --recv-keys E084DAB9
11+
- echo "deb https://cloud.r-project.org/bin/linux/ubuntu xenial-cran35/" | sudo tee -a /etc/apt/sources.list
12+
- sudo apt-get update -y
13+
- sudo apt-get install -y r-base
14+
- sudo Rscript -e "install.packages('knitr', repos = 'https://', dependencies = TRUE)"
15+
- sudo Rscript -e "install.packages('stringr', repos = 'https://cran.rstudio.com', dependencies = TRUE)"
16+
- sudo Rscript -e "install.packages('checkpoint', repos = 'https://cran.rstudio.com', dependencies = TRUE)"
17+
- sudo Rscript -e "install.packages('ggplot2', repos = 'https://cran.rstudio.com', dependencies = TRUE)"
18+
- rvm default
19+
- gem install json kramdown jekyll bundler
20+
install:
21+
- pip install pyyaml
22+
script:
23+
- make lesson-check-all
24+
- make --always-make site

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+
[The Carpentries][c-site] ([Software Carpentry][swc-site], [Data Carpentry][dc-site], and [Library Carpentry][lc-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 [The Carpentries][c-site]
18+
agrees to abide by our [code of conduct](CODE_OF_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/carpentries/lesson-example>,
54+
which documents the format of our lessons
55+
and can be viewed at <https://carpentries.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/carpentries/workshop-template>.
59+
The home page of that repository explains how to set up workshop websites,
60+
while the extra pages in <https://carpentries.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/carpentries/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 submitting [bug reports][issues]
73+
about things that don't work, aren't clear, or are missing.
74+
If you are looking for ideas, please see the 'Issues' tab for
75+
a list of issues associated with this repository,
76+
or you may also look at the issues for [Data Carpentry][dc-issues],
77+
[Software Carpentry][swc-issues], and [Library Carpentry][lc-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, macOS, 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, you may want to look at
105+
[How to Contribute to an Open Source Project on GitHub][how-contribute].
106+
To manage changes, we follow [GitHub flow][github-flow].
107+
Each lesson has two maintainers who review issues and pull requests or encourage others to do so.
108+
The maintainers are community volunteers and have final say over what gets merged into the lesson.
109+
To use the web interface for contributing to a lesson:
110+
111+
1. Fork the originating repository to your GitHub profile.
112+
2. Within your version of the forked repository, move to the `gh-pages` branch and
113+
create a new branch for each significant change being made.
114+
3. Navigate to the file(s) you wish to change within the new branches and make revisions as required.
115+
4. Commit all changed files within the appropriate branches.
116+
5. Create individual pull requests from each of your changed branches
117+
to the `gh-pages` branch within the originating repository.
118+
6. If you receive feedback, make changes using your issue-specific branches of the forked
119+
repository and the pull requests will update automatically.
120+
7. Repeat as needed until all feedback has been addressed.
121+
122+
When starting work, please make sure your clone of the originating `gh-pages` branch is up-to-date
123+
before creating your own revision-specific branch(es) from there.
124+
Additionally, please only work from your newly-created branch(es) and *not*
125+
your clone of the originating `gh-pages` branch.
126+
Lastly, published copies of all the lessons are available in the `gh-pages` branch of the originating
127+
repository for reference while revising.
128+
129+
## Other Resources
130+
131+
General discussion of [Software Carpentry][swc-site] and [Data Carpentry][dc-site]
132+
happens on the [discussion mailing list][discuss-list],
133+
which everyone is welcome to join.
134+
You can also [reach us by email][email].
135+
136+
[email]: mailto:[email protected]
137+
[dc-issues]: https://github.com/issues?q=user%3Adatacarpentry
138+
[dc-lessons]: http://datacarpentry.org/lessons/
139+
[dc-site]: http://datacarpentry.org/
140+
[discuss-list]: http://lists.software-carpentry.org/listinfo/discuss
141+
[github]: https://github.com
142+
[github-flow]: https://guides.github.com/introduction/flow/
143+
[github-join]: https://github.com/join
144+
[how-contribute]: https://egghead.io/series/how-to-contribute-to-an-open-source-project-on-github
145+
[issues]: https://guides.github.com/features/issues/
146+
[swc-issues]: https://github.com/issues?q=user%3Aswcarpentry
147+
[swc-lessons]: https://software-carpentry.org/lessons/
148+
[swc-site]: https://software-carpentry.org/
149+
[c-site]: https://carpentries.org/
150+
[lc-site]: https://librarycarpentry.org/
151+
[lc-issues]: https://github.com/issues?q=user%3Alibrarycarpentry

README.md

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
# FIXME Lesson title
2+
3+
[![Create a Slack Account with us](https://img.shields.io/badge/Create_Slack_Account-The_Carpentries-071159.svg)](https://swc-slack-invite.herokuapp.com/)
4+
5+
This repository generates the corresponding lesson website from [The Carpentries](https://carpentries.org/) repertoire of lessons.
6+
7+
## Contributing
8+
9+
We welcome all contributions to improve the lesson! Maintainers will do their best to help you if you have any
10+
questions, concerns, or experience any difficulties along the way.
11+
12+
We'd like to ask you to familiarize yourself with our [Contribution Guide](CONTRIBUTING.md) and have a look at
13+
the [more detailed guidelines][lesson-example] on proper formatting, ways to render the lesson locally, and even
14+
how to write new episodes.
15+
16+
Please see the current list of [issues][FIXME] for ideas for contributing to this
17+
repository. For making your contribution, we use the GitHub flow, which is
18+
nicely explained in the chapter [Contributing to a Project](http://git-scm.com/book/en/v2/GitHub-Contributing-to-a-Project) in Pro Git
19+
by Scott Chacon.
20+
Look for the tag ![good_first_issue](https://img.shields.io/badge/-good%20first%20issue-gold.svg). This indicates that the maintainers will welcome a pull request fixing this issue.
21+
22+
23+
## Maintainer(s)
24+
25+
Current maintainers of this lesson are
26+
27+
* FIXME
28+
* FIXME
29+
* FIXME
30+
31+
32+
## Authors
33+
34+
A list of contributors to the lesson can be found in [AUTHORS](AUTHORS)
35+
36+
## Citation
37+
38+
To cite this lesson, please consult with [CITATION](CITATION)
39+
40+
[lesson-example]: https://carpentries.github.io/lesson-example

_episodes/01-introduction.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
---
2+
title: "Introduction"
3+
teaching: 0
4+
exercises: 0
5+
questions:
6+
- "Key question (FIXME)"
7+
objectives:
8+
- "First learning objective. (FIXME)"
9+
keypoints:
10+
- "First key point. Brief Answer to questions. (FIXME)"
11+
---
12+
FIXME
13+
14+
{% include links.md %}
15+

_extras/about.md

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

_extras/discuss.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
title: Discussion
3+
---
4+
FIXME
5+
6+
{% include links.md %}

_extras/figures.md

Lines changed: 79 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,79 @@
1+
---
2+
title: Figures
3+
---
4+
5+
{% include base_path.html %}
6+
{% include manual_episode_order.html %}
7+
8+
<script>
9+
window.onload = function() {
10+
var lesson_episodes = [
11+
{% for lesson_episode in lesson_episodes %}
12+
{% if site.episode_order %}
13+
{% assign episode = site.episodes | where: "slug", lesson_episode | first %}
14+
{% else %}
15+
{% assign episode = lesson_episode %}
16+
{% endif %}
17+
"{{ episode.url }}"{% unless forloop.last %},{% endunless %}
18+
{% endfor %}
19+
];
20+
21+
var xmlHttp = []; /* Required since we are going to query every episode. */
22+
for (i=0; i < lesson_episodes.length; i++) {
23+
24+
xmlHttp[i] = new XMLHttpRequest();
25+
xmlHttp[i].episode = lesson_episodes[i]; /* To enable use this later. */
26+
xmlHttp[i].onreadystatechange = function() {
27+
28+
if (this.readyState == 4 && this.status == 200) {
29+
var parser = new DOMParser();
30+
var htmlDoc = parser.parseFromString(this.responseText,"text/html");
31+
var htmlDocArticle = htmlDoc.getElementsByTagName("article")[0];
32+
33+
var article_here = document.getElementById(this.episode);
34+
var images = htmlDocArticle.getElementsByTagName("img");
35+
36+
if (images.length > 0) {
37+
var h1text = htmlDocArticle.getElementsByTagName("h1")[0].innerHTML;
38+
39+
var htitle = document.createElement('h2');
40+
htitle.innerHTML = h1text;
41+
article_here.appendChild(htitle);
42+
43+
var image_num = 0;
44+
for (let image of images) {
45+
image_num++;
46+
47+
var title = document.createElement('p');
48+
title.innerHTML = "<strong>Figure " + image_num + ".</strong> " + image.alt;
49+
article_here.appendChild(title);
50+
51+
article_here.appendChild(image.cloneNode(false));
52+
53+
if (image_num < images.length) {
54+
var hr = document.createElement('hr');
55+
article_here.appendChild(hr);
56+
}
57+
}
58+
}
59+
}
60+
}
61+
episode_url = "{{ relative_root_path }}" + lesson_episodes[i];
62+
xmlHttp[i].open("GET", episode_url);
63+
xmlHttp[i].send(null);
64+
}
65+
}
66+
</script>
67+
68+
{% comment %} Create anchor for each one of the episodes. {% endcomment %}
69+
70+
{% for lesson_episode in lesson_episodes %}
71+
{% if site.episode_order %}
72+
{% assign episode = site.episodes | where: "slug", lesson_episode | first %}
73+
{% else %}
74+
{% assign episode = lesson_episode %}
75+
{% endif %}
76+
<article id="{{ episode.url }}" class="figures"></article>
77+
{% endfor %}
78+
79+
{% include links.md %}

_extras/guide.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
title: "Instructor Notes"
3+
---
4+
FIXME
5+
6+
{% include links.md %}

0 commit comments

Comments
 (0)