From d1ab67739cd3ea1337fcee623d30e3c28d442382 Mon Sep 17 00:00:00 2001 From: catchSheep <81134674+catchSheep@users.noreply.github.com> Date: Tue, 30 Jul 2024 13:39:45 +0800 Subject: [PATCH] Customizing template for workshop --- README.md | 194 ++-------------------------------------- _config.yml | 2 +- _includes/schedule.html | 82 ++++++++++------- index.md | 37 +++----- 4 files changed, 70 insertions(+), 245 deletions(-) diff --git a/README.md b/README.md index 810b2e8..5c83d3b 100644 --- a/README.md +++ b/README.md @@ -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-". 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/` -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 `` keywords. an enclosing `` indicates a row, and an enclosing `` (forward slash tr) and before the next `` (bare tr): - ```html - - - - - ``` - To remove a row, delete everything withing an enclosing ` ... `, including the `` \& `` parts. - -6. Ensure `setup/index.md` (which is hosted at to `curtinids.github.io//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 restart your shell -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 - cd - 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 :localhost: -``` -then navigate in your web-browser to localhost: - - -## 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//page`, whereas on your local machine this will be `localhost:/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. -``` -some text -``` - - - -## 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:team@carpentries.org -[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) \ No newline at end of file diff --git a/_config.yml b/_config.yml index 5a09d2e..3867cfa 100644 --- a/_config.yml +++ b/_config.yml @@ -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")? diff --git a/_includes/schedule.html b/_includes/schedule.html index 396a826..6805d9b 100644 --- a/_includes/schedule.html +++ b/_includes/schedule.html @@ -11,16 +11,28 @@

Day 1

rel="noopener noreferrer">Pre-workshop survey - - + + + + + + + + + + + + + + - + - - + + @@ -28,23 +40,23 @@

Day 1

- + - - + + - - + + - - +
` 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 `
TIME>DESCRIPTION
09:00Automating Tasks with the Unix Shell08:30Arrival and initial set-up help (if needed)
9:00Introduction to the Workshop and Tools
9:30Python Fundamentals
10:15Morning Tea
10:30Morning breakAnalysing Patient Data
11:00Automating Tasks with the Unix Shell (Continued)11:15Visualising Patient Data
12:00
13:00Building Programs with PythonStoring Multiple Values in Lists
14:30Afternoon break14:00Afternoon Tea
15:00Building Programs with Python (Continued)14:15Repeating Actions with Loops
16:00 Wrap-up
16:30END16:30/td> + End of Day 1
@@ -53,45 +65,53 @@

Day 2

- - + + - - + + - - + + - + + + + + + + + + + + + + - - + + - + - - + + - - - - - - - +
09:00Version Control with Git08:30Arrival and initial set-up (if needed)
10:30Morning break9:00Revision
11:00Version Control with Git (Continued)9:15Analysing Data from Multiple Files
12:0010:15Morning Tea
10:60Making Choices
11:30Creating Functions
12:30 Lunch break
13:00Managing Data with SQL13:30Introduction to Pandas
14:30Afternoon breakAfternoon Tea
15:00Managing Data with SQL (Continued)14:45Introduction to Pandas cont.
16:00Wrap-up
16:30Wrap-up & Post-workshop Survey
16:40END4:30/td> + End of Python Day 2
diff --git a/index.md b/index.md index b10d1f8..24b167c 100644 --- a/index.md +++ b/index.md @@ -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: ["curtinids@curtin.edu.au"] # boxed, comma-separated list of contact email addresses for the host, lead instructor, or whoever else is handling questions, like ["marlyn.wescoff@example.org", "fran.bilas@example.org", "ruth.lichterman@example.org"] 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) @@ -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 %} - -
-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. -
- -