Skip to content

Commit

Permalink
Customizing template for workshop
Browse files Browse the repository at this point in the history
  • Loading branch information
@catchSheep
catchSheep committed Jul 30, 2024
1 parent e72935d commit d1ab677
Show file tree
Hide file tree
Showing 4 changed files with 70 additions and 245 deletions.
194 changes: 5 additions & 189 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -1,189 +1,5 @@
[![Website](https://github.com/carpentries/workshop-template/actions/workflows/website.yml/badge.svg)](https://github.com/carpentries/workshop-template/actions/workflows/website.yml)

# The CIDS' Carpentries Workshop Template for Python

This repository is CIDS' version of The [Carpentries'][swc-site]template for creating websites for workshops.

1. **Please _do not fork this repository directly on GitHub._** Instead, please use GitHub's
"template" function following [the instructions below](#creating-a-repository) to copy this
`workshop-template` repository and customize it for your workshop.

2. Please *do your work in your repository's `gh-pages` branch*, since that is what is
[automatically published as a website by GitHub][github-project-pages].

3. Once you are done, please also [let the Carpentires know][email] the workshop URL. If this is a self-organised workshop, you should also [fill in the self-organized workshop
form][self-organized-workshop-form] (if you have not already done so), so they can keep track of
all workshops. They build the list of workshops on our websites from the data included in your
`index.md` page. We can only do that if you [customize][customization] that page correctly *and*
let us know the workshop URL.

# Creating and Customizing the website
The website is made using jekyll, which creates static html pages from markdown (and/or html).
Making the website is straightforward if you follow these steps after logging into github:
1. Use the Github template function (top-right green button) to create a new repository in the CIDS domain. Title the new repo "YYYY-MM-DD-curtin-carpentries-<lang>". e.g. "2024-02-04-curtin-carpentries-python"

![screenshot of this repository's GitHub page with an arrow pointing to the the 'use this template' button on the top left](fig/select-github-use-template.png?raw=true)
2. If the repo is public, a new webpage should be created at `curtinids.github.io/<reponame>`
3. Edit the workshop title in '_config.yml'. You shouldnt need to edit nay other settings
4. Edit relevant information at the top of "index.md". If you want to change any other wording on the main page (other than the scheudle), scroll down and make your changes using html. Make sure to delete the alert block at the top (next to the comment that tells you to delete it)
5. Edit "_includes/schedule.html". This file is inserted into the main index. You will be editing the two tables defined after the `<table class="table table-striped">` keywords. an enclosing `<tr>` indicates a row, and an enclosing `<td>` indicates a column. By default, there will be two rows per column.
If you want to insert another row, copy and paste the following into the desired location in the table after a `</tr>` (forward slash tr) and before the next `<tr>` (bare tr):
```html
<tr>
<td>TIME></td>
<td>DESCRIPTION</td>
</tr>
```
To remove a row, delete everything withing an enclosing `<tr> ... </tr>`, including the `<tr>` \& `</tr>` parts.

6. Ensure `setup/index.md` (which is hosted at to `curtinids.github.io/<reponame>/setup` ) is up to date

7. Have a browse through the website and make sure there's no placeholders left and everything is correct






# Working locally
When making a large amount of changes to the website, it may be preferable to work locally to avoid needing to push to github to test your changes. Here we describe both the setup needed and the commands to run it.
## Pre-requisites
This website currently requires a specific ruby version, 2.7.3.
### Windows/OS X
Follow the instructions [here](https://carpentries.github.io/lesson-example/setup.html#jekyll-setup-for-lesson-development) for OS X/ Windows. There's also a Linux section in that link, but it involves installing homebrew. See below for an alternate way.

### Linux alternate install
Unfortunately the ubuntu/debian versions are currently out of date, and while conda-forge has newer and older versions, it does not have 2.7.3.
To install 2.7.3 on linux, it's usually easiest to do the following:
1. Install [rbenv](https://github.com/rbenv/rbenv.git) (Ruby environment manager):
```shell
git clone https://github.com/rbenv/rbenv.git ~/.rbenv
~/.rbenv/bin/rbenv init
```
then <u><b>restart your shell</b></u>
2. Install the ruby build plugin into the rbenv folder
```
git clone https://github.com/rbenv/ruby-build.git "$(rbenv root)"/plugins/ruby-build
```
3. Use the following commands to install ruby 2.7.3, download the repo, set the local ruby version in the local directory to 2.7.3, install all the needed packages, and then cleanup:
```
rbenv init
rbenv install 2.7.3
git clone <repo>
cd <repo dir>
rbenv local 2.7.3
rbenv shell 2.7.3
gem install bundler
make clean
```


## Building the website locally
Once you've installed the pre-requisites, simply `cd` into the repo folder in a terminal and run:
```
make serve
```
If you're working on a remote server via ssh, you can pass through the ports with:
```
ssh -N -L <local port>:localhost:<port on host>
```
then navigate in your web-browser to localhost:<port>
## Optional but Recommended Steps
### Update your repository description and link your website
At the top of your repository on GitHub you'll see
~~~
No description, website, or topics provided. — Edit
~~~
Click 'Edit' and add:
1. A very brief description of your workshop in the "Description" box (e.g., "Oomza University workshop, Dec. 2016")
2. The URL for your workshop in the "Website" box (e.g., `https://gvwilson.github.io/2016-12-01-oomza`)
This will help people find your website if they come to your repository's home page. You may wish to check the box "Use Github pages link."
### Update the content of the README file
You can 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.
## Creating Extra Pages
In rare cases,
you may want to add extra pages to your workshop website.
You can do this by putting either Markdown or HTML pages in the website's root directory
and styling them according to the instructions give in
[the lesson template][lesson-example].
- A `.../subdir/index.md` file will be mapped to `.../subdir` on the website, and
- any other `.../subdir/filename.md` file will be mapped to `.../subdir/filename.html` on the website
Be wary, that on github the pages will be hosted at `curtinids.github.io/<repo name>/page`, whereas on your local machine this will be `localhost:<port>/page`. This may mean links that work locally dont work on the web page, so be sure to specify links explicitly using the variable `relative_root_path`, e.g.
```
<a href={{ relative_root_path }}/page>some text</a>
```
## Additional Notes
**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].
**Note:**
this template includes some files and directories that most workshops do not need,
but which provide a standard place to put extra content if desired.
See the [design notes][design] for more information about these.
Further instructions are available in [the customization instructions][customization].
This [FAQ][faq] includes a few extra tips (additions are always welcome)
and these notes on [the background and design][design] of this template may help as well.
## Installing Software
If you want to set up Jekyll so that you can preview changes on your own machine before pushing them
to GitHub, you must install the software described in the lesson example .
## Setting Up a Separate Repository for Learners
If you are teaching Git,
you should create a separate repository for learners to use in that lesson.
You should not have them use the workshop website repository because:
* your workshop website repository contains many files that most learners don't need to see during
the lesson, and
* you probably don't want to accidentally merge a damaging pull request from a novice Git user into
your workshop's website while you are using it to teach.
You can call this repository whatever you like, and add whatever content you need to it.
## Getting and Giving Help
We are committed to offering a pleasant setup experience for our learners and organizers.
If you find bugs in our instructions,
or would like to suggest improvements,
please [file an issue][issues]
or [mail us][email].
[email]: mailto:[email protected]
[customization]: https://carpentries.github.io/workshop-template/customization/index.html
[dc-site]: https://datacarpentry.org
[design]: https://carpentries.github.io/workshop-template/design/index.html
[faq]: https://carpentries.github.io/workshop-template/faq/index.html
[github-project-pages]: https://help.github.com/en/github/working-with-github-pages/creating-a-github-pages-site
[issues]: https://github.com/carpentries/workshop-template/issues
[lesson-example]: https://carpentries.github.io/lesson-example/
[self-organized-workshop-form]: https://amy.carpentries.org/forms/self-organised/
[swc-site]: https://software-carpentry.org
[lc-site]: https://librarycarpentry.org
# CIDS Workshop Website
This is the data needed to create the website for the CIDS-Carpentry to be hosted on the 9th of the 4th.
If you've found this page, you might actually be looking for either:
- [The website](https://CurtinIDS.github.io/2024-09-04-curtin-carpentries-python)
- [The workshop materials github repository](https://github.com/CurtinIDS/CIDS_Carpentries_Python)
2 changes: 1 addition & 1 deletion _config.yml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
# Most workshops don't use extra pages. More information about extra
# pages are included in the README:
# https://github.com/carpentries/workshop-template#creating-extra-pages
title: "Workshop Title"
title: "CIDS Python Workshop"


# Which carpentry is this ("swc", "dc", "lc", or "cp")?
Expand Down
82 changes: 51 additions & 31 deletions _includes/schedule.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,40 +11,52 @@ <h3>Day 1</h3>
rel="noopener noreferrer">Pre-workshop survey</a> </td>
</tr>
<tr>
<td>09:00</td>
<td>Automating Tasks with the Unix Shell</td>
<td>08:30</td>
<td>Arrival and initial set-up help (if needed)</td>
</tr>
<tr>
<td>9:00</td>
<td>Introduction to the Workshop and Tools</td>
</tr>
<tr>
<td>9:30</td>
<td>Python Fundamentals</td>
</tr>
<tr>
<td>10:15</td>
<td>Morning Tea</td>
</tr>
<tr>
<td>10:30</td>
<td>Morning break</td>
<td>Analysing Patient Data</td>
</tr>
<tr>
<td>11:00</td>
<td>Automating Tasks with the Unix Shell (Continued)</td>
<td>11:15</td>
<td>Visualising Patient Data</td>
</tr>
<tr>
<td>12:00</td>
<td>Lunch break</td>
</tr>
<tr>
<td>13:00</td>
<td>Building Programs with Python</td>
<td>Storing Multiple Values in Lists</td>
</tr>
<tr>
<td>14:30</td>
<td>Afternoon break</td>
<td>14:00</td>
<td>Afternoon Tea</td>
</tr>
<tr>
<td>15:00</td>
<td>Building Programs with Python (Continued)</td>
<td>14:15</td>
<td>Repeating Actions with Loops</td>
</tr>
<tr>
<td>16:00</td>
<td>Wrap-up</td>
</tr>
<tr>
<td>16:30</td>
<td>END</td>
<td>16:30/td>
<td>End of Day 1</td>
</tr>
</table>
</div>
Expand All @@ -53,45 +65,53 @@ <h3>Day 2</h3>
<!-- This is the next table for Day 2-->
<table class="table table-striped">
<tr>
<td>09:00</td>
<td>Version Control with Git</td>
<td>08:30</td>
<td>Arrival and initial set-up (if needed)</td>
</tr>
<tr>
<td>10:30</td>
<td>Morning break</td>
<td>9:00</td>
<td>Revision</td>
</tr>
<tr>
<td>11:00</td>
<td>Version Control with Git (Continued)</td>
<td>9:15</td>
<td>Analysing Data from Multiple Files</td>
</tr>
<tr>
<td>12:00</td>
<td>10:15</td>
<td>Morning Tea</td>
</tr>
<tr>
<td>10:60</td>
<td>Making Choices</td>
</tr>
<tr>
<td>11:30</td>
<td>Creating Functions</td>
</tr>
<tr>
<td>12:30</td>
<td>Lunch break</td>
</tr>
<tr>
<td>13:00</td>
<td>Managing Data with SQL</td>
<td>13:30</td>
<td>Introduction to Pandas</td>
</tr>
<tr>
<td>14:30</td>
<td>Afternoon break</td>
<td>Afternoon Tea</td>
</tr>
<tr>
<td>15:00</td>
<td>Managing Data with SQL (Continued)</td>
<td>14:45</td>
<td>Introduction to Pandas cont.</td>
</tr>
<tr>
<td>16:00</td>
<td>Wrap-up</td>
</tr>
<tr>
<td>16:30</td>
<td><a href="{{ site.post_survey }}{{ site.github.project_title }}" target="_blank"
<td>Wrap-up & <a href="{{ site.post_survey }}{{ site.github.project_title }}" target="_blank"
rel="noopener noreferrer">Post-workshop Survey</a></td>
</tr>
<tr>
<td>16:40</td>
<td>END</td>
<td>4:30/td>
<td>End of Python Day 2</td>
</tr>
</table>
</div>
Expand Down
37 changes: 13 additions & 24 deletions index.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,19 +3,19 @@ layout: workshop # DON'T CHANGE THIS.
# More detailed instructions (including how to fill these variables for an
# online workshop) are available at
# https://carpentries.github.io/workshop-template/customization/index.html
venue: "FIXME" # brief name of the institution that hosts the workshop without address (e.g., "Euphoric State University")
address: "FIXME" # full street address of workshop (e.g., "Room A, 123 Forth Street, Blimingen, Euphoria"), videoconferencing URL, or 'online'
country: "FIXME" # lowercase two-letter ISO country code such as "fr" (see https://en.wikipedia.org/wiki/ISO_3166-1#Current_codes) for the institution that hosts the workshop
language: "FIXME" # lowercase two-letter ISO language code such as "fr" (see https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) for the workshop
latitude: "45" # decimal latitude of workshop venue (use https://www.latlong.net/)
longitude: "-1" # decimal longitude of the workshop venue (use https://www.latlong.net)
mazemaps_url: # Mazemaps URL (use https://properties.curtin.edu.au/visit-curtin/campus-maps/ click your building, then click the share button, e.g. https://link.mazemap.com/kBQQTJKo)
humandate: "FIXME" # human-readable dates for the workshop (e.g., "Feb 17-18, 2020")
humantime: "FIXME" # human-readable times for the workshop e.g., "9:00 am - 4:30 pm CEST (7:00 am - 2:30 pm UTC)"
startdate: FIXME # machine-readable start date for the workshop in YYYY-MM-DD format like 2015-01-01
enddate: FIXME # machine-readable end date for the workshop in YYYY-MM-DD format like 2015-01-02
instructor: ["instructor one", "instructor two"] # boxed, comma-separated list of instructors' names as strings, like ["Kay McNulty", "Betty Jennings", "Betty Snyder"]
helper: ["helper one", "helper two"] # boxed, comma-separated list of helpers' names, like ["Marlyn Wescoff", "Fran Bilas", "Ruth Lichterman"]
venue: "Curtin University" # brief name of the institution that hosts the workshop without address (e.g., "Euphoric State University")
address: "Kent St, Bentley" # full street address of workshop (e.g., "Room A, 123 Forth Street, Blimingen, Euphoria"), videoconferencing URL, or 'online'
country: "au" # lowercase two-letter ISO country code such as "fr" (see https://en.wikipedia.org/wiki/ISO_3166-1#Current_codes) for the institution that hosts the workshop
language: "en" # lowercase two-letter ISO language code such as "fr" (see https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) for the workshop
latitude: "115.894" # decimal latitude of workshop venue (use https://www.latlong.net/)
longitude: "-32.006" # decimal longitude of the workshop venue (use https://www.latlong.net)
mazemaps_url: https://link.mazemap.com/CDsmz5ul # Mazemaps URL (use https://properties.curtin.edu.au/visit-curtin/campus-maps/ click your building, then click the share button, e.g. https://link.mazemap.com/kBQQTJKo)
humandate: "September 4th-5th 2024" # human-readable dates for the workshop (e.g., "Feb 17-18, 2020")
humantime: "9am-4:30pm AWST" # human-readable times for the workshop e.g., "9:00 am - 4:30 pm CEST (7:00 am - 2:30 pm UTC)"
startdate: 2024-09-04 # machine-readable start date for the workshop in YYYY-MM-DD format like 2015-01-01
enddate: 2024-09-05 # machine-readable end date for the workshop in YYYY-MM-DD format like 2015-01-02
instructor: ["Calvin Pang", "leigh Tyers"] # boxed, comma-separated list of instructors' names as strings, like ["Kay McNulty", "Betty Jennings", "Betty Snyder"]
helper: ["Rhys Sheil", "Alex Massen-Hane", "Kristina Gagalova", "Martin Cupák", "Nancy Tippaya", "Kathryn Napier"] # boxed, comma-separated list of helpers' names, like ["Marlyn Wescoff", "Fran Bilas", "Ruth Lichterman"]
email: ["[email protected]"] # boxed, comma-separated list of contact email addresses for the host, lead instructor, or whoever else is handling questions, like ["[email protected]", "[email protected]", "[email protected]"]
collaborative_notes: # optional: URL for the workshop collaborative notes, e.g. an Etherpad or Google Docs document (e.g., https://pad.carpentries.org/2015-01-01-euphoria)
eventbrite: # optional: alphanumeric key for Eventbrite registration, e.g., "1234567890AB" (if Eventbrite is being used)
Expand All @@ -25,17 +25,6 @@ eventbrite: # optional: alphanumeric key for Eventbrite registration,



{% comment %}
For a workshop please delete the following 'div' block of class 'alert alert-danger' and this comment. This is just a check to make sure you're paying attention and are editing this document
Altneratively delete everything include the {% comment %} and {% endcomment %}
{% endcomment %}

<div class="alert alert-danger">
This is the workshop template. Delete these lines and use it to customize
your own website. You will need to edit the header of this file (`index.md`), and ensure both `_includes/schedule.html` and `setup/index.md` are accurate. For `_includes/schedule.html`, you should be able to copy-paste lines as needed.
</div>





Expand Down

0 comments on commit d1ab677

Please sign in to comment.