Commit 397e572d authored by Greg Wilson's avatar Greg Wilson
Browse files

We now have a `CONTRIBUTING.md` page in `core`, so we need to explain

what it's for and how to edit it for each lesson.
parent ffc9e2bc
Loading
Loading
Loading
Loading
+12 −3
Original line number Diff line number Diff line
@@ -113,11 +113,15 @@ The root directory holds the content of the lesson, and must contain:
7.  `instructors.md`: the instructor's guide for the lesson. See
    "Instructor's Guide" below.

Note that the lesson's title is repeated in several files.  We could
8.  `CONTRIBUTING.md`: instructions for people who want to contribute.
    This file should be edited to replace references to `lesson-template`
    with references to your lesson's repository.

Note: the lesson's title is repeated in several files.  We could
put this in the Makefile, and insert it into pages when compiling, but
then authors would have to edit the Makefile (which we want to avoid).
We could also put it in some sort of configuration file, but again,
we're trying to avoid those.
We could also put it in some sort of configuration file, but they're
not a standard part of Pandoc, so we're avoiding them as well.

## Home Page

@@ -329,6 +333,11 @@ The discussion page

    *   Second point of general discussion.

Note: the discussion page is not meant to be more lesson material, so
it should not contain challenges and the like.  Instead, it should
give pointers to other lessons and tools that learners might find
useful, etc.

## Instructor's Guide

Learners may go through lessons outside of class, so it seems best to
+4 −1
Original line number Diff line number Diff line
@@ -33,7 +33,10 @@ lesson is `data-cleanup`.
    $ git remote add origin https://github.com/mcurie/data-cleanup
    ~~~

5.  Create and edit files (explained below).
5.  Create and edit files as explained in
    [Lesson Layout](LAYOUT.md),
    [Background and Design](DESIGN.md),
    and the [FAQ](FAQ.md).

6.  Build the HTML pages for your lesson: