Commit 9d91ca28 authored by Greg Wilson's avatar Greg Wilson
Browse files

Merge branch 'gh-pages' of github.com:swcarpentry/lesson-example into gh-pages

parents b447fbcf b18f5816

CONDUCT.md

+1 −1
Original line number Diff line number Diff line
@@ -41,4 +41,4 @@ may be reported by opening an issue or contacting one or more of the project mai 
This Code of Conduct is adapted from

the [Contributor Covenant][contrib-covenant] Version 1.0.0.



[contrib-covenant]: http://contributor-covenant.org/
 
{% include links.md %}

LICENSE.md

+2 −5
Original line number Diff line number Diff line
@@ -76,8 +76,5 @@ WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. 
"Software Carpentry" and "Data Carpentry" and their respective logos

are registered trademarks of [NumFOCUS][numfocus].



[cc-by-human]: https://creativecommons.org/licenses/by/4.0/

[cc-by-legal]: https://creativecommons.org/licenses/by/4.0/legalcode

[mit-license]: http://opensource.org/licenses/mit-license.html

[numfocus]: http://numfocus.org/

[osi]: http://opensource.org
 
{% include links.md %}

Makefile

+11 −7
Original line number Diff line number Diff line
@@ -9,6 +9,7 @@ DST=_site 


# Controls

.PHONY : commands clean files

.NOTPARALLEL:

all : commands



## commands         : show all commands.
@@ -16,11 +17,11 @@ commands : 
	@grep -h -E '^##' ${MAKEFILES} | sed -e 's/## //g'



## serve            : run a local server.

serve : lesson-rmd

serve : lesson-md

	${JEKYLL} serve



## site             : build files but do not run a server.

site : lesson-rmd

site : lesson-md

	${JEKYLL} build



# repo-check        : check repository settings.
@@ -53,7 +54,7 @@ workshop-check : 
## ----------------------------------------

## Commands specific to lesson websites.



.PHONY : lesson-check lesson-rmd lesson-files lesson-fixme

.PHONY : lesson-check lesson-md lesson-files lesson-fixme



# RMarkdown files

RMD_SRC = $(wildcard _episodes_rmd/??-*.Rmd)
@@ -79,13 +80,16 @@ HTML_DST = \ 
  $(patsubst _extras/%.md,${DST}/%/index.html,$(wildcard _extras/*.md)) \

  ${DST}/license/index.html



## lesson-rmd       : convert Rmarkdown files to markdown

lesson-rmd: $(RMD_SRC)

	@bin/knit_lessons.sh $(RMD_SRC)

## lesson-md        : convert Rmarkdown files to markdown

lesson-md : ${RMD_DST}



# Use of .NOTPARALLEL makes rule execute only once

${RMD_DST} : ${RMD_SRC}

	@bin/knit_lessons.sh ${RMD_SRC}



## lesson-check     : validate lesson Markdown.

lesson-check :

	@bin/lesson_check.py -s . -p ${PARSER}

	@bin/lesson_check.py -s . -p ${PARSER} -r _includes/links.md



## lesson-check-all : validate lesson Markdown, checking line lengths and trailing whitespace.

lesson-check-all :

_episodes/01-design.md

+1 −4
Original line number Diff line number Diff line
@@ -9,7 +9,6 @@ objectives: 
- "Describe the purpose and implementation of formative assessments."

keypoints:

- "Lessons are design in four stages: conceptual, summative, formative, and connective."

training: http://swcarpentry.github.io/instructor-training

---



This episode describes how we go about designing lessons and why.
@@ -113,6 +112,4 @@ it takes too long, 
there are usually too many possible right solutions to discuss in just a couple of minutes,

and many novices find a blank page (or screen) intimidating.



[concept-maps]: {{ page.training }}/08-memory/

[python-gapminder]: https://swcarpentry.github.io/python-novice-gapminder/

[training]: {{ page.training }}/
 
{% include links.md %}

_episodes/02-tooling.md

+1 −9
Original line number Diff line number Diff line
@@ -164,12 +164,4 @@ we store files that appear directly in the navigation bar 
in the root directory of the lesson.

[The next episode]({{ page.root }}/03-organization/) describes these files.



[github-importer]: https://import.github.com/

[jekyll]: http://jekyllrb.com/

[jekyll-collection]: https://jekyllrb.com/docs/collections/

[jekyll-install]: https://jekyllrb.com/docs/installation/

[jupyter]: https://jupyter.org/

[pandoc]: https://pandoc.org/

[r-markdown]: http://rmarkdown.rstudio.com/

[rstudio]: https://www.rstudio.com/

[yaml]: http://yaml.org/
 
{% include links.md %}