Skip to content
This repository has been archived by the owner on Jan 3, 2018. It is now read-only.

Commit

Permalink
Replace bootcamp with workshop
Browse files Browse the repository at this point in the history
~~~
$ for file in $(grep -r -l 'bootcamp' .); do sed -i 's/bootcamp/workshop/g' $file; done
$ for file in $(grep -r -l 'boot camp' .); do sed -i 's/boot camp/workshop/g' $file; done
~~~

and others minors changes.

Close #240.
  • Loading branch information
Raniere Silva committed Sep 30, 2014
1 parent 0aa91fb commit fb4d59c
Show file tree
Hide file tree
Showing 24 changed files with 114 additions and 114 deletions.
4 changes: 2 additions & 2 deletions CONTRIBUTING.md
Expand Up @@ -13,7 +13,7 @@ you are agreeing that Software Carpentry may redistribute your work under

Before beginning anything major,
please read the [README.md](README.md) file in this directory,
which explains how this repository is used to create websites for bootcamps.
which explains how this repository is used to create websites for workshops.
We also recommend that you look through [open issues](https://github.com/swcarpentry/bc/issues)
and [pull requests](https://github.com/swcarpentry/bc/pulls) to see what other people could use help with,
and then open an issue of your own to get feedback on your ideas and coordinate with other developers.
Expand Down Expand Up @@ -67,7 +67,7 @@ you can run the same checks using:
python bin/swc_index_validator.py ./index.html
~~~

This checks that the bootcamp's instructors are listed,
This checks that the workshop's instructors are listed,
that a contact email address has been set up,
and so on.

Expand Down
2 changes: 1 addition & 1 deletion Makefile
@@ -1,5 +1,5 @@
#======================================================================
# Default Makefile for Software Carpentry bootcamps. Use 'make' on
# Default Makefile for Software Carpentry workshops. Use 'make' on
# its own to see a list of targets.
#
# To add new lessons, add their Markdown files to the MOST_SRC target.
Expand Down
80 changes: 40 additions & 40 deletions README.md
@@ -1,15 +1,15 @@
Software Carpentry Bootcamps
============================

The `bc` repository is the starting point for creating your own bootcamp website:
it contains a template for your bootcamp's home page,
The `bc` repository is the starting point for creating your own workshop website:
it contains a template for your workshop's home page,
and also hosts the shared lesson materials we have developed.
Most material is written in Markdown,
but our Python and SQL lessons are written as IPython Notebooks.
The sections below explain:

* how GitHub turns a repository into a web site,
* how you can build a website for your bootcamp using this repo as a starting point,
* how you can build a website for your workshop using this repo as a starting point,
* what lessons we have,
* where they're located, and
* how to add new lessons.
Expand All @@ -22,9 +22,9 @@ You may also want to view these videos:
* [Adding Lesson Material to the Software Carpentry Bootcamp Repository](https://vimeo.com/92273942)

**Note:**
If you are teaching Git in your bootcamp,
If you are teaching Git in your workshop,
you should create *two* repositories:
one for your bootcamp's website,
one for your workshop's website,
and one for learners to clone and update during your lessons.
You should not try to use the same repo for both purposes because:

Expand All @@ -41,7 +41,7 @@ you can run the same checks using:
python bin/swc_index_validator.py ./index.html
~~~

This checks that the bootcamp's instructors are listed,
This checks that the workshop's instructors are listed,
that a contact email address has been set up,
and so on.

Expand Down Expand Up @@ -78,7 +78,7 @@ rather than Git itself.

2. A user on GitHub can only have one fork of a particular repo.
This is a problem for us because
an instructor may be involved in several bootcamps,
an instructor may be involved in several workshops,
each of which has its own website repo.
Those website repositories ought to be forks of this one,
but since GitHub doesn't allow that,
Expand Down Expand Up @@ -147,13 +147,13 @@ rather than Git itself.
then expands the result.
This is used to give the pages in a site a uniform appearance.

We have created three standard layouts for bootcamp pages:
We have created three standard layouts for workshop pages:

* `bootcamp.html` is used for bootcamps' home pages,
* `workshop.html` is used for workshops' home pages,
and is the layout for the `index.html` page in your repo's root directory.
That `index.html` page's header must
[define several variables](#variables)
in order for your bootcamp to be included in our main website.
in order for your workshop to be included in our main website.

* `lesson.html` is used to lay out pages for individual lessons.
All of the lessons in this repository use it
Expand All @@ -165,18 +165,18 @@ We have created three standard layouts for bootcamp pages:
Getting Started
---------------

To create a website for a new bootcamp:
To create a website for a new workshop:

1. Create a [new repository on GitHub](https://github.com/new)
with a name like YYYY-MM-DD-site, e.g., `2014-03-31-esu`.
This repository must *not* be a fork of an existing repository
because as mentioned earlier,
GitHub only allows a user to fork a repository once,
but many instructors are involved in several bootcamps.
Please use the same ID for your bootcamp
but many instructors are involved in several workshops.
Please use the same ID for your workshop
that the Software Carpentry admins are using to identify it
(i.e.,
if the admins called the bootcamp `2014-03-31-esu`,
if the admins called the workshop `2014-03-31-esu`,
please *don't* call your repo `euphoric-march-2014`),
and please use all lower-case
(i.e., '2014-03-31-esu' instead of '2014-03-31-ESU').
Expand Down Expand Up @@ -216,7 +216,7 @@ To create a website for a new bootcamp:
$ git remote rm swc
~~~

7. Edit `index.html` to create the bootcamp home page.
7. Edit `index.html` to create the workshop home page.
In particular,
double-check
[the variables in the page's header](#variables),
Expand All @@ -226,16 +226,16 @@ To create a website for a new bootcamp:
to check `index.html` for problems
by running the command `make check`.

8. Change `lessons` variable in `index.html` so that it reflects the lessons that the bootcamp will cover.
8. Change `lessons` variable in `index.html` so that it reflects the lessons that the workshop will cover.
This controls which setup instructions are displayed,
and described in more detail in the section on [variables](#variables).

8. Edit `_includes/setup.html` to provide software installation instructions for bootcamp attendees.
8. Edit `_includes/setup.html` to provide software installation instructions for workshop attendees.
This is described in more detail in the section on [website content](#website-content).

9. [Preview your changes](#previewing-the-site).

10. Replace the content of this `README.md` file with a line or two describing your bootcamp.
10. Replace the content of this `README.md` file with a line or two describing your workshop.

11. Push content to your YYYY-MM-DD-site repository:

Expand All @@ -250,12 +250,12 @@ at the url:
http://{your-github-username}.github.io/YYYY-MM-DD-site/
~~~

You may update your bootcamp's website whenever you want.
You may update your workshop's website whenever you want.

Previewing the Site
-------------------

To preview your bootcamp's page(s),
To preview your workshop's page(s),
go into its root directory and run:

~~~
Expand All @@ -266,7 +266,7 @@ This will run `jekyll` to create the directory `./_site`.
The `index.html` page in this directory,
`./_site/index.html`,
should have the Software Carpentry look and feel
and the information about your bootcamp.
and the information about your workshop.

**Note:**
you will need to install Jekyll 1.0.3 or later in order to preview things locally.
Expand Down Expand Up @@ -307,11 +307,11 @@ $ jekyll -t build -d _site
Variables
---------

Your bootcamp's `index.html` page
(which uses the `bootcamp.html` layout from the `_layouts` directory)
Your workshop's `index.html` page
(which uses the `workshop.html` layout from the `_layouts` directory)
*must* define the following values in its YAML header:

* `layout` must be `bootcamp`.
* `layout` must be `workshop`.

* `root` is the path to the repository's root directory.
This is '.' if the page is in the root directory
Expand All @@ -321,25 +321,25 @@ Your bootcamp's `index.html` page
'../..' if it is two levels down,
and so on.

* `venue` is the name of the institution or group hosting the bootcamp.
* `venue` is the name of the institution or group hosting the workshop.

* `address` is the bootcamp's street address.
* `address` is the workshop's street address.

* `country` must be a hyphenated country name like 'United-States'.
This is used to look up flags for display in the main web site;
see the `assets/flags` directory in the `site` repo for a full list of valid names.

* `latlng` is the latitude and longitude of the bootcamp site
* `latlng` is the latitude and longitude of the workshop site
(so we can put a pin on our map).

* `humandate` is the human-friendly dates for the bootcamp (e.g., Jul 3-4, 2015).
* `humandate` is the human-friendly dates for the workshop (e.g., Jul 3-4, 2015).
Please use three- or four-letter month names and abbreviations
(e.g., `Dec` instead of `December`).

* `startdate` is the bootcamp's starting date in YYYY-MM-DD format.
* `startdate` is the workshop's starting date in YYYY-MM-DD format.

* `enddate` is the bootcamp's ending date in the same format.
If your bootcamp is only one day long,
* `enddate` is the workshop's ending date in the same format.
If your workshop is only one day long,
the `enddate` field can be deleted.

* `registration` is `open` (if anyone is allowed to sign up)
Expand All @@ -356,7 +356,7 @@ Your bootcamp's `index.html` page
This must be enclosed in square brackets,
as in `["John von Neumann"]`

* `contact` is the contact email address to use for your bootcamp.
* `contact` is the contact email address to use for your workshop.

* `lessons` is a list of the lessons actually being taught.
The values in this list control which sections of the setup instructions are displayed:
Expand All @@ -377,7 +377,7 @@ Website Content
---------------

The body of `index.html` contains
an explanation of what a bootcamp is and how it runs,
an explanation of what a workshop is and how it runs,
followed by setup instructions for our standard software.
There is an explanatory comment for each section of this page;
reorganize, rewrite, or delete the material as you think best.
Expand Down Expand Up @@ -462,19 +462,19 @@ The most important files and directories are **highlighted**.
* contents.md - site map used in place of `index.html` on the main web site.
* css/ - CSS files for this site.
* data/ - miscellaneous data files used by examples.
* etherpad.txt - starter text for the bootcamp's Etherpad.
* etherpad.txt - starter text for the workshop's Etherpad.
* gloss.md - glossary of terms.
* img/ - images used throughout this site.
* **index.html** - template for bootcamp home pages.
* **index.html** - template for workshop home pages.
* intermediate/ - intermediate lesson material (under development).
* intro.md - introduction to book version of this site.
* ipynb.mk - Makefile for turning IPython Notebooks into Markdown.
* js/ - Javascript files used in this site.
* lessons/ - old lesson material.
* novice/ - novice lesson material.
* rules.md - the rules of programming (used in the book version of this site).
* setup.md - placeholder for bootcamp setup instructions.
* setup/ - setup tools for installing bootcamp software.
* setup.md - placeholder for workshop setup instructions.
* setup/ - setup tools for installing workshop software.
* slides/ - slideshows (under construction).
* team.md - who we are.

Expand All @@ -487,10 +487,10 @@ FAQ
or join our [discussion list](http://software-carpentry.org/contrib/discuss.html)
and ask for help there.

* *Why does the bootcamp repository have to be created from scratch? Why not fork `bc` on GitHub?*
* *Why does the workshop repository have to be created from scratch? Why not fork `bc` on GitHub?*
<br/>
Because any particular user can only have one fork of a repository,
but instructors frequently need to work on several bootcamps at once.
but instructors frequently need to work on several workshops at once.

* *Why use Jekyll? Why not some other markup language and some other converter?*
<br/>
Expand Down Expand Up @@ -571,7 +571,7 @@ FAQ
$ sudo apt-get install pandoc
~~~

* *Where should pages go if multiple boot camps are running at a site simultaneously?*
* *Where should pages go if multiple workshops are running at a site simultaneously?*
<br/>
Use subdirectories like `2013-07-01-esu/beginners`,
so that main directory names always follow our four-part convention.
Expand Down
2 changes: 1 addition & 1 deletion _includes/setup.html
Expand Up @@ -350,7 +350,7 @@ <h4>Virtual Machine</h4>
Download our <a href="{{site.vm_url}}">VM image</a>.
<strong>Warning:</strong>
this file is 1.7 GByte,
so please download it <em>before</em> coming to your bootcamp.
so please download it <em>before</em> coming to your workshop.
</li>
<li>
Load the VM into VirtualBox by selecting "Import Appliance"
Expand Down
File renamed without changes.
10 changes: 5 additions & 5 deletions bin/setup-bootcamp.sh → bin/setup-workshop.sh
@@ -1,19 +1,19 @@
#!/bin/bash

## Setup new bootcamp
## Setup new workshop
##
## This script follow the steps in https://vimeo.com/87241285.
##
## Usage:
##
## $ ./setup-bootcamp.sh bootcamp_id description owner [instructor [instructor ...]]
## $ ./setup-workshop.sh workshop_id description owner [instructor [instructor ...]]
##
## Parameters:
##
## - `bootcamp_id`: is the identifier provide by Software Carpentry for the
## bootcamp that you will be running. It will be used for the name of the Git
## - `workshop_id`: is the identifier provide by Software Carpentry for the
## workshop that you will be running. It will be used for the name of the Git
## repository and is a name like YYYY-MM-DD-site, e.g., `2014-03-31-esu`.
## - `description`: is the description of the bootcamp that you will be running.
## - `description`: is the description of the workshop that you will be running.
## It should be multi-word and must be enclose with single or double quotes.
## - `owner`: this is your GitHub username.
## - `instructors`: this is the GitHub username of folks that will be teaching
Expand Down
10 changes: 5 additions & 5 deletions bin/swc_index_validator.py
Expand Up @@ -15,7 +15,7 @@
7. instructor and helper lists should be valid Python/Ruby lists
8. Template header should not exist
9. humandate should have three-letter month and four-letter year
10. layout should be 'bootcamp'
10. layout should be 'workshop'
11. root must be '.'
12. humantime should have 'am' or 'pm' or both
13. address, venue should be non-empty
Expand Down Expand Up @@ -43,8 +43,8 @@
SUB_ERROR = '\t{0}\n'

def check_layout(layout):
'''Checks whether layout equals "bootcamp".'''
return layout == 'bootcamp'
'''Checks whether layout equals "workshop".'''
return layout == 'workshop'

def check_root(root):
'''Checks root - can only be "."'''
Expand Down Expand Up @@ -134,7 +134,7 @@ def check_pass(value):


HANDLERS = {
'layout' : (True, check_layout, 'layout isn\'t "bootcamp".'),
'layout' : (True, check_layout, 'layout isn\'t "workshop".'),
'root' : (True, check_root, 'root can only be ".".'),
'country' : (True, check_country, 'country invalid. Please check whether there are spaces inside the country-name.'),
'humandate' : (True, check_humandate, 'humandate invalid. Please use three-letter months like "Jan" and four-letter years like "2025".'),
Expand Down Expand Up @@ -198,7 +198,7 @@ def get_header(index_fh):
header.append(line)
this_categories.append(line.split(":")[0].strip())

if "This page is a template for bootcamp home pages." in line:
if "This page is a template for workshop home pages." in line:
sys.stderr.write('WARN:\tYou seem to still have the template header in your index.html. Please remove that.\n')
sys.stderr.write('\tLook for: "<!-- Remove the block below. -->" in the index.html.\n')
break # we can stop here - for now, just check header and template header
Expand Down
6 changes: 3 additions & 3 deletions bin/test_swc_index_validator.py
Expand Up @@ -18,7 +18,7 @@ def make_file(text):


def test_check_layout():
assert validator.check_layout("bootcamp")
assert validator.check_layout("workshop")

def test_check_layout_fail():
assert not validator.check_layout("lesson")
Expand Down Expand Up @@ -154,7 +154,7 @@ def test_check_not_eventbrite_non_digits():

def test_check_with_enddate():
header_sample = """---
layout: bootcamp
layout: workshop
root: .
venue: Euphoric State University
address: 123 College Street, Euphoria
Expand All @@ -174,7 +174,7 @@ def test_check_with_enddate():

def test_check_without_enddate():
header_sample = """---
layout: bootcamp
layout: workshop
root: .
venue: Euphoric State University
address: 123 College Street, Euphoria
Expand Down

0 comments on commit fb4d59c

Please sign in to comment.