Skip to content

Commit

Permalink
Move instructors section to CUSTOMIZATION
Browse files Browse the repository at this point in the history
The information at the web pages should target students.
Information for instructors should go into CUSTOMIZATION.md.
  • Loading branch information
Raniere Silva committed Apr 19, 2015
1 parent 733cf35 commit 1719c35
Show file tree
Hide file tree
Showing 2 changed files with 61 additions and 63 deletions.
34 changes: 32 additions & 2 deletions CUSTOMIZATION.md
Original file line number Diff line number Diff line change
Expand Up @@ -87,9 +87,39 @@ The header may optionally define the following:
this line. Note: this value must be given as a string in double
quotes, rather than as a number.

## Home Page: Schedule, Syllabus, and Setup
## Home Page: Schedule and Syllabus

You should edit the sections titled `Schedule` and `Syllabus`
so that they show what you're actually planning to teach and when.
You should also delete irrelevant parts of the section titled `Setup`

## Home Page: Setup

You should irrelevant parts of the section titled `Setup`
so that your learners don't try to install software that they won't need.
After you edit the `Setup` section, you should edit the installation test script.

`swc-installation-test-1.py` is pretty simple, and just checks that
the students have a recent enough version of Python installed that
will be able to parse `swc-installation-test-2.py`.

`swc-installation-test-2.py`
checks for a list of dependencies and prints error messages if a
package is not installed, or if the installed version is not current
enough. By default, the script checks for pretty much anything that
has ever been used at a Software Carpentry workshop, which is probably
not what you want for your particular workshop.

Go through `swc-installation-test-2.py` and
comment any dependencies you don't need out of the `CHECKS` list. You
might also want to skim through the minimum version numbers listed
where particular dependencies are defined (e.g. `('git', 'Git', (1, 7,
0), None)`). For the most part, fairly conservative values have been
selected, so students with modern machines should be fine. If your
workshop has stricter version requirements, feel free to bump them
accordingly.

Similarly, the virtual dependencies can be satisfied by any of several
packages. If you don't want to support a particular package (e.g. if
you have no Emacs experience and don't want to be responsible for
students who show up with Emacs as their only editor), you can comment
out that particular `or_dependency`.
90 changes: 29 additions & 61 deletions setup/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,6 @@ layout: page
title: Testing Setup
root: ..
---
For Learners
------------

This directory contains scripts for testing your machine to make sure
you have the software you'll need for your workshop installed. To use
Expand Down Expand Up @@ -33,65 +31,35 @@ these scripts:
...
~~~
If you see something like:
If you see something like:
~~~
$ python swc-installation-test-2.py
check virtual-shell... fail
...
check for command line shell (virtual-shell) failed:
command line shell (virtual-shell) requires at least one of the following dependencies
For instructions on installing an up-to-date version, see
http://software-carpentry.org/setup/
causes:
check for Bourne Again Shell (bash) failed:
could not find 'bash' executable for Bourne Again Shell (bash)
For instructions on installing an up-to-date version, see
http://software-carpentry.org/setup/
...
~~~
follow the suggestions to try and install any missing software. For
additional troubleshooting information, you can use the `--verbose`
option:
~~~
$ python swc-installation-test-2.py --verbose
check virtual-shell... fail
...
==================
System information
==================
os.name : posix
...
~~~
For Instructors
---------------
`swc-installation-test-1.py` is pretty simple, and just checks that
the students have a recent enough version of Python installed that
they'll be able to parse `swc-installation-test-2.py`. The latter
checks for a list of dependencies and prints error messages if a
package is not installed, or if the installed version is not current
enough. By default, the script checks for pretty much anything that
has ever been used at a Software Carpentry workshop, which is probably
not what you want for your particular workshop.
Before your workshop, go through `swc-installation-test-2.py` and
comment any dependencies you don't need out of the `CHECKS` list. You
might also want to skim through the minimum version numbers listed
where particular dependencies are defined (e.g. `('git', 'Git', (1, 7,
0), None)`). For the most part, fairly conservative values have been
selected, so students with modern machines should be fine. If your
workshop has stricter version requirements, feel free to bump them
accordingly.
~~~
$ python swc-installation-test-2.py
check virtual-shell... fail
...
check for command line shell (virtual-shell) failed:
command line shell (virtual-shell) requires at least one of the following dependencies
For instructions on installing an up-to-date version, see
http://software-carpentry.org/setup/
causes:
check for Bourne Again Shell (bash) failed:
could not find 'bash' executable for Bourne Again Shell (bash)
For instructions on installing an up-to-date version, see
http://software-carpentry.org/setup/
...
~~~
Similarly, the virtual dependencies can be satisfied by any of several
packages. If you don't want to support a particular package (e.g. if
you have no Emacs experience and don't want to be responsible for
students who show up with Emacs as their only editor), you can comment
out that particular `or_dependency`.
follow the suggestions to try and install any missing software. For
additional troubleshooting information, you can use the `--verbose`
option:
Finally, don't forget to post your modified scripts somewhere where
your students can download them.
~~~
$ python swc-installation-test-2.py --verbose
check virtual-shell... fail
...
==================
System information
==================
os.name : posix
...
~~~

0 comments on commit 1719c35

Please sign in to comment.