Unverified Commit 8d4ba24b authored by François Michonneau's avatar François Michonneau
Browse files

Merge branch 'gh-pages' of https://github.com/swcarpentry/workshop-template into gh-pages

parents aedf30ed d5326b46
......@@ -33,7 +33,7 @@ for your learners to practice in.
2. Go to <a href="https://github.com/new/import" target="_blank">GitHub's importer</a>.
3. Paste the url of this repo as the old repository to clone:
<https://github.com/swcarpentry/workshop-template>.
<https://github.com/carpentries/workshop-template>.
4. Select the owner for your new repository.
(This will probably be you, but may instead be an organization you belong to.)
......@@ -52,7 +52,7 @@ for your learners to practice in.
You can now click "Begin Import".
When the process is done,
you will receive a message like
"Importing complete! Your new repository gvwilson/2016-12-01-miskatonic is ready."
"Importing complete! Your new repository jules32/2015-07-01-miskatonic is ready."
and you can go to the new repository by clicking on the name.
**Note:**
......@@ -85,7 +85,7 @@ please [get in touch](#getting-and-giving-help).
Editing hints are embedded in `index.md`,
and full instructions are in [the customization instructions][customization].
4. Edit `_config.yml` to customize certain site-wide variables, such as: `carpentry` (to tell us which carpentry workshop this is), `title` (overall title for all pages), `repository` (so that URLs resolve correctly both locally and on GitHub), `workshop_repo` (the URL of the workshop repository on GitHub) and `workshop_site` (the repository's GitHub Pages URL).
4. Edit `_config.yml` to customize certain site-wide variables, such as: `carpentry` (to tell us which carpentry workshop this is), `title` (overall title for all pages), `workshop_repo` (the URL of the workshop repository on GitHub) and `workshop_site` (the repository's GitHub Pages URL).
Editing hints are embedded in `_config.yml`,
and full instructions are in [the customization instructions][customization].
......@@ -119,6 +119,8 @@ please [get in touch](#getting-and-giving-help).
8. Optional: you can now change the README.md file in your website's repository, which contains these instructions, so that it contains a short description of your workshop and a link to the workshop website.
9. Optional: Add a link to your workshop website on the repository main page in the description/website section (look for the `Edit` button on the right to add).
**Note:**
please do all of your work in your repository's `gh-pages` branch,
since [GitHub automatically publishes that as a website][github-project-pages].
......@@ -247,16 +249,16 @@ please [file an issue][issues]
or [mail us][email].
[email]: mailto:team@carpentries.org
[customization]: https://swcarpentry.github.io/workshop-template/customization/
[customization]: https://carpentries.github.io/workshop-template/customization/
[dc-site]: http://datacarpentry.org
[design]: https://swcarpentry.github.io/workshop-template/design/
[faq]: https://swcarpentry.github.io/workshop-template/faq/
[design]: https://carpentries.github.io/workshop-template/design/
[faq]: https://carpentries.github.io/workshop-template/faq/
[github-project-pages]: https://help.github.com/articles/creating-project-pages-manually/
[importer]: https://github.com/new/import
[issues]: https://github.com/swcarpentry/workshop-template/issues
[issues]: https://github.com/carpentries/workshop-template/issues
[jekyll-windows]: http://jekyll-windows.juthilo.com/
[jekyll]: https://jekyllrb.com/
[lesson-example]: https://swcarpentry.github.io/lesson-example/
[lesson-example]: https://carpentries.github.io/lesson-example/
[pyyaml]: https://pypi.python.org/pypi/PyYAML
[ruby-install-guide]: https://www.ruby-lang.org/en/downloads/
[ruby-installer]: http://rubyinstaller.org/
......
......@@ -26,6 +26,8 @@ kind: "workshop"
repository: <USERNAME>/<PROJECT>
# Email address, no mailto:
# (Don't change this -- the contact address for your workshop will be set
# in the index.md file)
email: "team@carpentries.org"
# Sites.
......@@ -51,6 +53,8 @@ swc_post_survey: "https://www.surveymonkey.com/r/swc_post_workshop_v1?workshop_i
training_post_survey: "https://www.surveymonkey.com/r/post-instructor-training"
dc_pre_survey: "https://www.surveymonkey.com/r/dcpreworkshopassessment?workshop_id="
dc_post_survey: "https://www.surveymonkey.com/r/dcpostworkshopassessment?workshop_id="
lc_pre_survey: "https://www.surveymonkey.com/r/lcpreworkshopsurvey?workshop_id="
lc_post_survey: "https://www.surveymonkey.com/r/lcpostworkshopsurvey?workshop_id="
# Start time in minutes (0 to be clock-independent, 540 to show a start at 09:00 am).
start_time: 0
......
......@@ -9,7 +9,6 @@ You should edit the `_config.yml` configuration file in the root directory of yo
* `carpentry` - to tell us which carpentry workshop this is, possible values are ("swc", "dc" or "lc")
* `title` - overall title for all pages
* `repository` - as \<USERNAME>/\<PROJECT> (e.g. `gvwilson/2015-07-01-miskatonic`), so that URLs resolve correctly both locally and on GitHub - see https://help.github.com/articles/repository-metadata-on-github-pages
* `workshop_repo` - the URL of your workshop repository on GitHub
* `workshop_site` - the repository's GitHub Pages URL
......@@ -20,13 +19,13 @@ You should not need to modify any of the other values in `_config.yml`.
## Home Page: Data
Your workshop's home page lives in `index.html`,
Your workshop's home page lives in `index.md`,
which must define the following values in its header:
* `layout` must be `workshop`.
* `carpentry` must be either "dc" (for Data Carpentry) or "swc" (for
Software Carpentry).
* `carpentry` must be either "dc" (for Data Carpentry), "swc" (for
Software Carpentry) or "lc" (for Library Carpentry).
* `venue` is the short name of the institution or group hosting the
workshop, like "Euphoric State University". It should *not*
......@@ -50,7 +49,7 @@ which must define the following values in its header:
* `latlng` is the latitude and longitude of the workshop site (so we
can put a pin on our map). You can use
[this site](http://itouchmap.com/latlong.html) to find these
[this site](https://getlatlong.net/) to find these
values. You can *not* put spaces around the comma separating the
latitude from the longitude.
......@@ -98,7 +97,7 @@ which must define the following values in its header:
The header may optionally define the following:
* `etherpad` is the URL for the Etherpad for your workshop. If you are
not using an Etherpad, you can delete this line.
not using an Etherpad, you can delete this line. You can create a carpentries etherpad [here](https://pad.carpentries.org/).
* `eventbrite` is the multi-digit Eventbrite registration key. If you
are using Eventbrite, the Software Carpentry administrators will
......@@ -109,7 +108,9 @@ The header may optionally define the following:
## 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.
so that they show what you're actually planning to teach and when. These
files are located in the appropriate workshop folder (`dc`, `lc` or `swc`)
inside the `_includes` folder.
## Home Page: Setup
......@@ -120,7 +121,7 @@ so that learners don't spend time installing software they don't need.
## Setup: Installation tests
If you intend to use the installation-test scripts,
uncomment the paragraph linking to `setup/index.html` in `index.html`
uncomment the paragraph linking to `setup/index.html` in `index.md`
and edit `setup/swc-installation-test-2.py` as described below.
`swc-installation-test-1.py` is pretty simple, and just checks that
......@@ -160,7 +161,7 @@ please follow the steps bellow:
1. Add the workshop-template repository as upstream:
$ git remote add upstream https://github.com/swcarpentry/workshop-template.git
$ git remote add upstream https://github.com/carpentries/workshop-template.git
2. Fetch the data from upstream repository (also know as the workshop-template
repository):
......
<div class="row">
<div class="col-md-6">
<h3 id="syllabus-python">Introduction to Data</h3>
<h3 id="syllabus-data">Introduction to Data</h3>
<ul>
<li>Intro to data</li>
<li>Jargon busting</li>
......@@ -40,7 +40,7 @@
</div>
<div class="col-md-6">
<div class="col-md-6">
<h3 id="syllabus-r">OpenRefine</h3>
<h3 id="syllabus-openrefine">OpenRefine</h3>
<ul>
<li>Introduction to OpenRefine</li>
<li>Importing data</li>
......@@ -50,4 +50,4 @@
</ul>
</div>
</div>
</div>
\ No newline at end of file
</div>
......@@ -188,17 +188,16 @@ and our administrator may contact you if we need any extra information.</h4>
SURVEYS - DO NOT EDIT SURVEY LINKS
{% endcomment %}
<h2 id="surveys">Surveys</h2>
{% if page.carpentry == "swc" %}
<p>Please be sure to complete these surveys before and after the workshop.</p>
{% if site.carpentry == "swc" %}
<p><a href="{{ site.swc_pre_survey }}{{ site.github.project_title }}">Pre-workshop Survey</a></p>
<p><a href="{{ site.swc_post_survey }}{{ site.github.project_title }}">Post-workshop Survey</a></p>
{% elsif page.carpentry == "dc" %}
<p>Please be sure to complete these surveys before and after the workshop.</p>
{% elsif site.carpentry == "dc" %}
<p><a href="{{ site.dc_pre_survey }}{{ site.github.project_title }}">Pre-workshop Survey</a></p>
<p><a href="{{ site.dc_post_survey }}{{ site.github.project_title }}">Post-workshop Survey</a></p>
{% elsif page.carpentry == "lc" %}
<p>Ask your instructor about pre- and post-workshop Survey details.</p>
{% elsif site.carpentry == "lc" %}
<p><a href="{{ site.lc_pre_survey }}{{ site.github.project_title }}">Pre-workshop Survey</a></p>
<p><a href="{{ site.lc_post_survey }}{{ site.github.project_title }}">Post-workshop Survey</a></p>
{% endif %}
<hr/>
......@@ -315,18 +314,22 @@ and our administrator may contact you if we need any extra information.</h4>
<a href="https://www.youtube.com/watch?v=339AEqk9c-8">Video Tutorial</a>
<ol>
<li>Download the Git for Windows <a href="https://git-for-windows.github.io/">installer</a>.</li>
<li>Run the installer and follow the steps bellow:
<li>Run the installer and follow the steps below:
<ol>
{% comment %} Git 2.8.2 Setup {% endcomment %}
{% comment %} Information {% endcomment %}
<li>Click on "Next".</li>
{% comment %} Select Components {% endcomment %}
<li>Click on "Next".</li>
{% comment %} Git 2.18.0 Setup {% endcomment %}
<li>
Click on "Next" four times (two times if you've previously
installed Git). You don't need to change anything
in the Information, location, components, and start menu screens.
</li>
<li>
<strong>
Select “Use the nano editor by default” and click on “Next”.
</strong>
</li>
{% comment %} Adjusting your PATH environment {% endcomment %}
<li>
<strong>
Keep "Use Git from the Windows Command Prompt" selected and click on "Next".
</strong>
If you forgot to do this programs that you need for the workshop will not work properly.
If this happens rerun the installer and select the appropriate option.
</li>
......@@ -334,14 +337,12 @@ and our administrator may contact you if we need any extra information.</h4>
<li>Click on "Next".</li>
{% comment %} Configuring the line ending conversions {% endcomment %}
<li>
<strong>
Keep "Checkout Windows-style, commit Unix-style line endings" selected and click on "Next".
</strong>
</li>
{% comment %} Configuring the terminal emulator to use with Git Bash {% endcomment %}
<li>
<strong>
Keep "Use Windows' default console window" selected and click on "Next".
Select "Use Windows' default console window" and click on "Next".
</strong>
</li>
{% comment %} Configuring experimental performance tweaks {% endcomment %}
......@@ -428,6 +429,9 @@ and our administrator may contact you if we need any extra information.</h4>
<strong>For OS X 10.9 and higher</strong>, install Git for Mac
by downloading and running the most recent "mavericks" installer from
<a href="http://sourceforge.net/projects/git-osx-installer/files/">this list</a>.
Because this installer is not signed by the developer, you may have to
right click (control click) on the .pkg file, click Open, and click
Open on the pop up window.
After installing Git, there will not be anything in your <code>/Applications</code> folder,
as Git is a command line program.
<strong>For older versions of OS X (10.5-10.8)</strong> use the
......@@ -453,32 +457,20 @@ and our administrator may contact you if we need any extra information.</h4>
<p>
When you're writing code, it's nice to have a text editor that is
optimized for writing code, with features like automatic
color-coding of key words. The default text editor on macOS and
color-coding of key words. The default text editor on macOS and
Linux is usually set to Vim, which is not famous for being
intuitive. If you accidentally find yourself stuck in it, try
typing the escape key, followed by <code>:q!</code> (colon, lower-case 'q',
exclamation mark), then hitting Return to return to the shell.
intuitive. If you accidentally find yourself stuck in it, hit
the <kbd>Esc</kbd> key, followed by <kbd>:</kbd>+<kbd>Q</kbd>+<kbd>!</kbd>
(colon, lower-case 'q', exclamation mark), then hitting <kbd>Return</kbd> to
return to the shell.
</p>
<div class="row">
<div class="col-md-4">
<h4 id="editor-windows">Windows</h4>
<a href="https://www.youtube.com/watch?v=339AEqk9c-8">Video Tutorial</a>
<p>
nano is a basic editor and the default that instructors use in the workshop.
To install it,
download the <a href="{{site.swc_installer}}">
{% if page.carpentry == "swc" %}
Software Carpentry
{% elsif page.carpentry == "dc" %}
Data Carpentry
{% elsif page.carpentry == "lc" %}
Library Carpentry
{% endif %}
Windows installer
</a>
and double click on the file to run it.
<strong>This installer requires an active internet connection.</strong>
It is installed along with Git.
</p>
<p>
Others editors that you can use are
......@@ -557,7 +549,7 @@ and our administrator may contact you if we need any extra information.</h4>
<ol>
<li>Open <a href="https://www.anaconda.com/download/#windows">https://www.anaconda.com/download/#windows</a> with your web browser.</li>
<li>Download the Python 3 installer for Windows.</li>
<li>Install Python 3 using all of the defaults for installation <em>except</em> make sure to check <strong>Make Anaconda the default Python</strong>.</li>
<li>Install Python 3 using all of the defaults for installation <em>except</em> make sure to check <strong>Add Anaconda to my PATH environment variable</strong>.</li>
</ol>
</div>
<div class="col-md-4">
......@@ -583,15 +575,15 @@ and our administrator may contact you if we need any extra information.</h4>
</li>
<li>
Type <pre>bash Anaconda3-</pre> and then press
tab. The name of the file you just downloaded should
<kbd>Tab</kbd>. The name of the file you just downloaded should
appear. If it does not, navigate to the folder where you
downloaded the file, for example with:
<pre>cd Downloads</pre>
Then, try again.
</li>
<li>
Press enter. You will follow the text-only prompts. To move through
the text, press the space key. Type <code>yes</code> and
Press <kbd>Return</kbd>. You will follow the text-only prompts. To move through
the text, press <kbd>Spacebar</kbd>. Type <code>yes</code> and
press enter to approve the license. Press enter to approve the
default location for the files. Type <code>yes</code> and
press enter to prepend Anaconda to your <code>PATH</code>
......@@ -676,7 +668,7 @@ and our administrator may contact you if we need any extra information.</h4>
<div class="col-md-4">
<h4 id="sql-windows">Windows</h4>
<p>
The <a href="{{site.swc_installer}}">
The <a href="https://www.sqlite.org/download.html">
{% if page.carpentry == "swc" %}
Software Carpentry
{% elsif page.carpentry == "dc" %}
......
......@@ -49,6 +49,7 @@ def check():
if __name__ == '__main__':
if check():
print('Passed')
print('version of Python: ' + _sys.version)
else:
print('Failed')
print('Install a current version of Python 3!')
......
......@@ -109,7 +109,7 @@ CHECKS = [
# Python
'python',
'ipython', # Command line tool
'IPython', # Python package
'jupyter', # Former IPython features, notebook, etc.
'argparse', # Useful for utility scripts
'numpy',
'scipy',
......@@ -160,7 +160,7 @@ class DependencyError (Exception):
('*', '*', 'google-chrome'): 'https://www.google.com/intl/en/chrome/browser/',
('*', '*', 'hg'): 'http://mercurial.selenic.com/',
('*', '*', 'mercurial'): 'http://mercurial.selenic.com/',
('*', '*', 'IPython'): 'http://ipython.org/install.html',
('*', '*', 'jupyter'): 'http://jupyter.org/install.html',
('*', '*', 'ipython'): 'http://ipython.org/install.html',
('*', '*', 'jinja'): 'http://jinja.pocoo.org/docs/intro/#installation',
('*', '*', 'kate'): 'http://kate-editor.org/get-it/',
......@@ -835,14 +835,16 @@ for package,name,long_name,minimum_version,and_dependencies in [
CHECKER['py.test'].minimum_version, None),
('jinja2', 'jinja', 'Jinja', (2, 6), None),
('zmq', 'pyzmq', 'PyZMQ', (2, 1, 4), None),
('IPython', None, 'IPython Python package',
CHECKER['ipython'].minimum_version, [
('jupyter', None, 'Jupyter',
# FIXME should use minimum version for Jupyter
# CHECKER['ipython'].minimum_version, [
None, [
'jinja',
'tornado',
'pyzmq',
VirtualDependency(
name='virtual-browser-ipython',
long_name='IPython-compatible web browser',
long_name='Jupyter-compatible web browser',
or_dependencies=[
CommandDependency(
command=CHECKER['firefox'].command,
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment