Merge branch 'gh-pages' into auto-ids (989db444) · Commits · NDIP / Nova Packages / Nova Carpentry Tutorial

CONTRIBUTING.md

+2 −1

Original line number	Diff line number	Diff line
		@@ -102,7 +102,7 @@ you may want to look at
		[How to Contribute to an Open Source Project on GitHub][how-contribute].
		In brief:

		1. The published copy of the lesson is in the `gh-pages` branch of the repository
		1. The published copy of the lesson is in the [episodes][episodes] directory in the `gh-pages` branch of the repository
		(so that GitHub will regenerate it automatically).
		Please create all branches from that,
		and merge the [master repository][repo]'s `gh-pages` branch into your `gh-pages` branch
		@@ -146,3 +146,4 @@ You can also [reach us by email][contact].
		[swc-issues]: https://github.com/issues?q=user%3Aswcarpentry
		[swc-lessons]: http://software-carpentry.org/lessons/
		[swc-site]: http://software-carpentry.org/
		[episodes]: _episodes

README.md

+1 −1

Original line number	Diff line number	Diff line
		@@ -92,6 +92,6 @@ In brief:
		[github-pages]: https://help.github.com/articles/creating-project-pages-manually/
		[issues]: https://github.com/swcarpentry/lesson-example/issues
		[rendered]: https://swcarpentry.github.io/lesson-example/
		[setup]: https://github.com/swcarpentry/lesson-example/blob/gh-pages/setup.md
		[setup]: https://swcarpentry.github.io/lesson-example/setup/
		[styles-issues]: https://github.com/swcarpentry/styles/issues/
		[styles]: https://github.com/swcarpentry/styles/

_episodes/01-design.md

+1 −1

Original line number	Diff line number	Diff line
		@@ -113,6 +113,6 @@ 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 }}/07-memory/
		[concept-maps]: {{ page.training }}/08-memory/
		[python-gapminder]: https://swcarpentry.github.io/python-novice-gapminder/
		[training]: {{ page.training }}/

_episodes/02-tooling.md

+2 −2

Original line number	Diff line number	Diff line
		@@ -113,7 +113,7 @@ this page:
		---
		name: Science
		---
		Today we are going to study {{page.name}}.
		{% raw %}Today we are going to study {{page.name}}.{% endraw %}
		~~~
		{: .source}

		@@ -162,7 +162,7 @@ putting the extra files in `_extras` allows us to populate the "Extras" menu pul
		To clarify what will appear where,
		we store files that appear directly in the navigation bar
		in the root directory of the lesson.
		[The last episode]({{ page.root }}/03-organization/) describes these files.
		[The next episode]({{ page.root }}/03-organization/) describes these files.

		[github-importer]: https://import.github.com/
		[jekyll]: http://jekyllrb.com/

_episodes/03-organization.md

+84 −107

Original line number	Diff line number	Diff line
		@@ -78,41 +78,32 @@ which should not be modified:

		## Starter Files

		The `bin/lesson_initialize.py` script creates files that need to be customized for each lesson.
		The `bin/lesson_initialize.py` script creates files that need to be customized for each lesson:

		### `CONTRIBUTING.md`

		Contribution guidelines.
		`CONTRIBUTING.md`
		: Contribution guidelines.
		The `issues` and `repo` links at the bottom of the file must be changed
		to match the URLs of the lesson:
		look for uses of `{LESSON-NAME}`.

		### `_config.yml`
		look for uses of `FIXME`.

		The [Jekyll][jekyll] configuration file.
		`_config.yml`
		: The [Jekyll][jekyll] configuration file.
		This must be edited so that its links and other settings are correct for this lesson.

		* `carpentry` should be either "dc" (for Data Carpentry) or "swc" (for Software Carpentry).

		* `title` is the title of your lesson,
		e.g.,
		"Defence Against the Dark Arts".

		* `email` is the contact email address for the lesson.

		### `CITATION`
		`CITATION`
		: A plain text file explaining how to cite this lesson.

		A plain text file explaining how to cite this lesson.
		`AUTHORS`
		: A plain text file listing the names of the lesson's authors.

		### `AUTHORS`

		A plain text file listing the names of the lesson's authors.

		### `index.md`

		The home page for the lesson.

		1. It must use the `index` layout.
		`index.md`
		: The home page for the lesson.
		1. It must use the `lesson` layout.
		2. It must not have a `title` field in its [YAML][yaml] header.
		3. It must open with a few paragraphs of explanatory text.
		4. That introduction must be followed by a single `.prereq` blockquote
		@@ -122,71 +113,57 @@ The home page for the lesson.
		which generates the syllabus for the lesson
		from the metadata in its episodes.

		### `reference.md`

		A reference guide for the lesson.

		`reference.md`
		: A reference guide for the lesson.
		The template will automatically generate a summary of the episodes' key points.
		1. It must use the `reference` layout.
		2. Its title must be `"Reference"`.
		3. Its permalink must be `/reference/`.
		4. It should include a glossary, laid out as a description list.
		5. It may include other material as appropriate.

		The template will automatically generate a summary of the episodes' key points.

		### `setup.md`

		Detailed setup instructions for the lesson.

		1. It must use the `page` layout.
		2. Its title must be `"Setup"`.
		3. Its permalink must be `/setup/`.
		4. It should include whatever setup instructions are required.

		`setup.md`
		: Detailed setup instructions for the lesson.
		Note that we usually divide setup instructions by platform,
		e.g.,
		include level-2 headings for Windows, Mac OS X, and Linux
		with instructions for each.
		The [workshop template]({{ site.workshop_repo }})
		links to the setup instructions for core lessons.
		1. It must use the `page` layout.
		2. Its title must be `"Setup"`.
		3. Its permalink must be `/setup/`.
		4. It should include whatever setup instructions are required.

		### `_extras/about.md`

		General notes about this lesson.
		`_extras/about.md`
		: General notes about this lesson.
		This page includes brief descriptions of Software Carpentry and Data Carpentry,
		and is a good place to put institutional acknowledgments.

		### `_extras/discussion.md`

		General discussion of the lesson contents for learners who wish to know more:

		`_extras/discussion.md`
		: General discussion of the lesson contents for learners who wish to know more:
		This page normally includes links to further reading
		and/or brief discussion of more advanced topics.
		1. It must use the `page` layout.
		2. Its title must be `"Discussion"`.
		3. Its permalink must be `/discuss/`.
		4. It may include whatever content the author thinks appropriate.

		This page normally includes links to further reading
		and/or brief discussion of more advanced topics.

		### `_extra/figures.md` and `_includes/all_figures.html`

		Does nothing but include `_includes/all_figures.html`,
		`_extra/figures.md` and `_includes/all_figures.html`
		: Does nothing but include `_includes/all_figures.html`,
		which is (re)generated by `make lesson-figures`.
		This page displays all the images referenced by all of the episodes,
		in order,
		so that instructors can scroll through them while teaching.

		### `_extras/guide.md`

		The instructors' guide for the lesson.

		`_extras/guide.md`
		: The instructors' guide for the lesson.
		This page records tips and warnings from people who have taught the lesson.
		1. It must use the `page` layout.
		2. Its title must be `"Instructors' Guide"`.
		3. Its permalink must be `/guide/`.
		4. It may include whatever content the author thinks appropriate.

		This page records tips and warnings from people who have taught the lesson.

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