Skip to content

Commit 767b1be

Browse files
committed
merge styles v9.5.2
2 parents 30f3a04 + 2b8a946 commit 767b1be

20 files changed

+74
-32
lines changed

Diff for: .gitignore

+3
Original file line numberDiff line numberDiff line change
@@ -6,3 +6,6 @@
66
__pycache__
77
_site
88
.Rproj.user
9+
.Rhistory
10+
.RData
11+

Diff for: CONDUCT.md renamed to CODE_OF_CONDUCT.md

-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
---
22
layout: page
33
title: "Contributor Code of Conduct"
4-
permalink: /conduct/
54
---
65
As contributors and maintainers of this project,
76
we pledge to follow the [Carpentry Code of Conduct][coc].

Diff for: Makefile

+6-1
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44
# Settings
55
MAKEFILES=Makefile $(wildcard *.mk)
66
JEKYLL=jekyll
7+
JEKYLL_VERSION=3.7.3
78
PARSER=bin/markdown_ast.rb
89
DST=_site
910

@@ -16,6 +17,10 @@ all : commands
1617
commands :
1718
@grep -h -E '^##' ${MAKEFILES} | sed -e 's/## //g'
1819

20+
## docker-serve : use docker to build the site
21+
docker-serve :
22+
docker run --rm -it -v ${PWD}:/srv/jekyll -p 127.0.0.1:4000:4000 jekyll/jekyll:${JEKYLL_VERSION} make serve
23+
1924
## serve : run a local server.
2025
serve : lesson-md
2126
${JEKYLL} serve
@@ -63,7 +68,7 @@ RMD_DST = $(patsubst _episodes_rmd/%.Rmd,_episodes/%.md,$(RMD_SRC))
6368
# Lesson source files in the order they appear in the navigation menu.
6469
MARKDOWN_SRC = \
6570
index.md \
66-
CONDUCT.md \
71+
CODE_OF_CONDUCT.md \
6772
setup.md \
6873
$(sort $(wildcard _episodes/*.md)) \
6974
reference.md \

Diff for: _includes/lesson_footer.html

+2-2
Original file line numberDiff line numberDiff line change
@@ -44,8 +44,8 @@
4444
</div>
4545
<div class="row">
4646
<div class="col-md-12" align="center">
47-
Using <a href="https://github.com/swcarpentry/styles/">The Carpentries style</a>
48-
version <a href="https://github.com/swcarpentry/styles/releases/tag/v9.5.0">9.5.0</a>.
47+
Using <a href="https://github.com/carpentries/styles/">The Carpentries style</a>
48+
version <a href="https://github.com/carpentries/styles/releases/tag/v9.5.2">9.5.2</a>.
4949
</div>
5050
</div>
5151
</footer>

Diff for: _includes/links.md

+4-1
Original file line numberDiff line numberDiff line change
@@ -9,14 +9,16 @@
99
[cran-checkpoint]: https://cran.r-project.org/package=checkpoint
1010
[cran-knitr]: https://cran.r-project.org/package=knitr
1111
[cran-stringr]: https://cran.r-project.org/package=stringr
12-
[email]: mailto:[email protected]
12+
[dc-lessons]: http://www.datacarpentry.org/lessons/
13+
[email]: mailto:[email protected]
1314
[github-importer]: https://import.github.com/
1415
[importer]: https://github.com/new/import
1516
[jekyll-collection]: https://jekyllrb.com/docs/collections/
1617
[jekyll-install]: https://jekyllrb.com/docs/installation/
1718
[jekyll-windows]: http://jekyll-windows.juthilo.com/
1819
[jekyll]: https://jekyllrb.com/
1920
[jupyter]: https://jupyter.org/
21+
[lc-lessons]: https://librarycarpentry.org/#portfolio
2022
[lesson-example]: https://carpentries.github.io/lesson-example/
2123
[mit-license]: https://opensource.org/licenses/mit-license.html
2224
[morea]: https://morea-framework.github.io/
@@ -32,6 +34,7 @@
3234
[ruby-installer]: https://rubyinstaller.org/
3335
[rubygems]: https://rubygems.org/pages/download/
3436
[styles]: https://github.com/carpentries/styles/
37+
[swc-lessons]: https://software-carpentry.org/lessons/
3538
[swc-releases]: https://github.com/swcarpentry/swc-releases
3639
[workshop-repo]: {{ site.workshop_repo }}
3740
[yaml]: http://yaml.org/

Diff for: _includes/navbar.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@
3838
<ul class="nav navbar-nav">
3939

4040
{% comment %} Always show code of conduct. {% endcomment %}
41-
<li><a href="{{ page.root }}{% link CONDUCT.md %}">Code of Conduct</a></li>
41+
<li><a href="{{ page.root }}{% link CODE_OF_CONDUCT.md %}">Code of Conduct</a></li>
4242

4343
{% if site.kind == "lesson" %}
4444
{% comment %} Show setup instructions. {% endcomment %}

Diff for: bin/boilerplate/CODE_OF_CONDUCT.md

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
---
2+
layout: page
3+
title: "Contributor Code of Conduct"
4+
---
5+
As contributors and maintainers of this project,
6+
we pledge to follow the [Carpentry Code of Conduct][coc].
7+
8+
Instances of abusive, harassing, or otherwise unacceptable behavior
9+
may be reported by following our [reporting guidelines][coc-reporting].
10+
11+
{% include links.md %}

Diff for: bin/boilerplate/CONTRIBUTING.md

+7-7
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ In exchange,
1515
we will address your issues and/or assess your change proposal as promptly as we can,
1616
and help you become a member of our community.
1717
Everyone involved in [Software Carpentry][swc-site] and [Data Carpentry][dc-site]
18-
agrees to abide by our [code of conduct](CONDUCT.md).
18+
agrees to abide by our [code of conduct](CODE_OF_CONDUCT.md).
1919

2020
## How to Contribute
2121

@@ -50,19 +50,19 @@ and to meet some of our community members.
5050
which can be viewed at <https://swcarpentry.github.io/FIXME>.
5151

5252
2. If you wish to change the example lesson,
53-
please work in <https://github.com/swcarpentry/lesson-example>,
53+
please work in <https://github.com/carpentries/lesson-example>,
5454
which documents the format of our lessons
55-
and can be viewed at <https://swcarpentry.github.io/lesson-example>.
55+
and can be viewed at <https://carpentries.github.io/lesson-example>.
5656

5757
3. If you wish to change the template used for workshop websites,
58-
please work in <https://github.com/swcarpentry/workshop-template>.
58+
please work in <https://github.com/carpentries/workshop-template>.
5959
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>
60+
while the extra pages in <https://carpentries.github.io/workshop-template>
6161
provide more background on our design choices.
6262

6363
4. If you wish to change CSS style files, tools,
6464
or HTML boilerplate for lessons or workshops stored in `_includes` or `_layouts`,
65-
please work in <https://github.com/swcarpentry/styles>.
65+
please work in <https://github.com/carpentries/styles>.
6666

6767
## What to Contribute
6868

@@ -145,4 +145,4 @@ You can also [reach us by email][email].
145145
[issues]: https://guides.github.com/features/issues/
146146
[swc-issues]: https://github.com/issues?q=user%3Aswcarpentry
147147
[swc-lessons]: https://software-carpentry.org/lessons/
148-
[swc-site]: https://software-carpentry.org/
148+
[swc-site]: https://software-carpentry.org/

Diff for: bin/boilerplate/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -25,4 +25,4 @@ A list of contributors to the lesson can be found in [AUTHORS](AUTHORS)
2525

2626
To cite this lesson, please consult with [CITATION](CITATION)
2727

28-
[lesson-example]: https://swcarpentry.github.io/lesson-example
28+
[lesson-example]: https://carpentries.github.io/lesson-example

Diff for: bin/boilerplate/_config.yml

+15-12
Original file line numberDiff line numberDiff line change
@@ -2,17 +2,16 @@
22
# Values for this lesson.
33
#------------------------------------------------------------
44

5-
# Which carpentry is this ("swc", "dc", or "lc")?
5+
# Which carpentry is this ("swc", "dc", "lc", or "cp")?
6+
# swc: Software Carpentry
7+
# dc: Data Carpentry
8+
# lc: Library Carpentry
9+
# cp: Carpentries (to use for instructor traning for instance)
610
carpentry: "swc"
711

812
# Overall title for pages.
913
title: "Lesson Title"
1014

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-
1615
#------------------------------------------------------------
1716
# Generic settings (should not need to change).
1817
#------------------------------------------------------------
@@ -22,24 +21,28 @@ kind: "lesson"
2221

2322
# Magic to make URLs resolve both locally and on GitHub.
2423
# See https://help.github.com/articles/repository-metadata-on-github-pages/.
24+
# Please don't change it: <USERNAME>/<PROJECT> is correct.
2525
repository: <USERNAME>/<PROJECT>
2626

27+
# Email address, no mailto:
28+
29+
2730
# Sites.
2831
amy_site: "https://amy.software-carpentry.org/workshops"
2932
carpentries_github: "https://github.com/carpentries"
3033
carpentries_pages: "https://carpentries.github.io"
3134
carpentries_site: "https://carpentries.org/"
3235
dc_site: "http://datacarpentry.org"
33-
example_repo: "https://github.com/swcarpentry/lesson-example"
34-
example_site: "https://swcarpentry.github.com/lesson-example"
36+
example_repo: "https://github.com/carpentries/lesson-example"
37+
example_site: "https://carpentries.github.io/lesson-example"
3538
lc_site: "https://librarycarpentry.github.io/"
3639
swc_github: "https://github.com/swcarpentry"
3740
swc_pages: "https://swcarpentry.github.io"
3841
swc_site: "https://software-carpentry.org"
39-
template_repo: "https://github.com/swcarpentry/styles"
40-
training_site: "https://swcarpentry.github.io/instructor-training"
41-
workshop_repo: "https://github.com/swcarpentry/workshop-template"
42-
workshop_site: "https://swcarpentry.github.io/workshop-template"
42+
template_repo: "https://github.com/carpentries/styles"
43+
training_site: "https://carpentries.github.io/instructor-training"
44+
workshop_repo: "https://github.com/carpentries/workshop-template"
45+
workshop_site: "https://carpentries.github.io/workshop-template"
4346

4447
# Surveys.
4548
pre_survey: "https://www.surveymonkey.com/r/swc_pre_workshop_v1?workshop_id="

Diff for: bin/boilerplate/_episodes/01-introduction.md

+7-4
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,12 @@ title: "Introduction"
33
teaching: 0
44
exercises: 0
55
questions:
6-
- "Key question"
6+
- "Key question (FIXME)"
77
objectives:
8-
- "First objective."
8+
- "First objective. (FIXME)"
99
keypoints:
10-
- "First key point."
11-
---
10+
- "First key point. (FIXME)"
11+
---
12+
FIXME
13+
14+
{% include links.md %}

Diff for: bin/boilerplate/_extras/about.md

+1
Original file line numberDiff line numberDiff line change
@@ -2,3 +2,4 @@
22
title: About
33
---
44
{% include carpentries.html %}
5+
{% include links.md %}

Diff for: bin/boilerplate/_extras/discuss.md

+2
Original file line numberDiff line numberDiff line change
@@ -2,3 +2,5 @@
22
title: Discussion
33
---
44
FIXME
5+
6+
{% include links.md %}

Diff for: bin/boilerplate/_extras/figures.md

+2
Original file line numberDiff line numberDiff line change
@@ -36,3 +36,5 @@ Create anchor for each one of the episodes.
3636
{% for episode in site.episodes %}
3737
<article id="{{ episode.url }}"></article>
3838
{% endfor %}
39+
40+
{% include links.md %}

Diff for: bin/boilerplate/_extras/guide.md

+2
Original file line numberDiff line numberDiff line change
@@ -2,3 +2,5 @@
22
title: "Instructor Notes"
33
---
44
FIXME
5+
6+
{% include links.md %}

Diff for: bin/boilerplate/index.md

+2
Original file line numberDiff line numberDiff line change
@@ -9,3 +9,5 @@ FIXME: home page introduction
99
>
1010
> FIXME
1111
{: .prereq}
12+
13+
{% include links.md %}

Diff for: bin/boilerplate/reference.md

+2
Original file line numberDiff line numberDiff line change
@@ -5,3 +5,5 @@ layout: reference
55
## Glossary
66

77
FIXME
8+
9+
{% include links.md %}

Diff for: bin/boilerplate/setup.md

+3
Original file line numberDiff line numberDiff line change
@@ -2,3 +2,6 @@
22
title: Setup
33
---
44
FIXME
5+
6+
7+
{% include links.md %}

Diff for: bin/lesson_check.py

+2-2
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@
2626
# specially. This list must include all the Markdown files listed in the
2727
# 'bin/initialize' script.
2828
REQUIRED_FILES = {
29-
'%/CONDUCT.md': True,
29+
'%/CODE_OF_CONDUCT.md': True,
3030
'%/CONTRIBUTING.md': False,
3131
'%/LICENSE.md': True,
3232
'%/README.md': False,
@@ -171,7 +171,7 @@ def check_config(reporter, source_dir):
171171
reporter.check_field(config_file, 'configuration',
172172
config, 'kind', 'lesson')
173173
reporter.check_field(config_file, 'configuration',
174-
config, 'carpentry', ('swc', 'dc', 'lc'))
174+
config, 'carpentry', ('swc', 'dc', 'lc', 'cp'))
175175
reporter.check_field(config_file, 'configuration', config, 'title')
176176
reporter.check_field(config_file, 'configuration', config, 'email')
177177

Diff for: bin/lesson_initialize.py

+1
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@
1111
'.travis.yml',
1212
'AUTHORS',
1313
'CITATION',
14+
'CODE_OF_CONDUCT.md',
1415
'CONTRIBUTING.md',
1516
'README.md',
1617
'_config.yml',

0 commit comments

Comments
 (0)