Commit 6cecfeb0 authored by Greg Wilson's avatar Greg Wilson
Browse files

Fixing layout of descriptions of standard pages

parent 8d1f5d1f
Loading
Loading
Loading
Loading
+84 −107
Original line number Diff line number Diff line
@@ -78,40 +78,31 @@ 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 `FIXME`.

### `_config.yml`

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.

### `index.md`

The home page for the lesson.
`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 `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.
@@ -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/