This is the conference website repository for Research Computing Leeds Conference 2022. It is based on a conference template created by Sam Kavanagh based largely on the Project Zeppelin / GDG DevFest 2014 site template.
_config.yml
gh-pages
branchhttp://[your github name].github.io/
Note: By default this template assumes you are going to be using a custom domain with it, and your files will be served from the root folder of this address. In order to deploy this site as a subdirectory, e.g. http://[your githubname].github.io/resbaz
modify the baseurl
field in _config.yml
(in this example to /resbaz
).
This repository includes a .devcontainer configuration file which if you have Docker and VSCode installed you can use to spin up a development environment pre configured with Ruby and Bundler.
If you want to develop this repository locally you can use the following steps.
To develop locally you will need Ruby installed.
I recommend installing Ruby via rvm
, this can be installed by following the relevant steps for your operating system.
Ubuntu users can install from a dedicated package.
Once rvm
is installed you can install Ruby with the line:
$ rvm install ruby-2.7.4
# you may have to configure your shell to be a login shell to run the below
# bash -l
$ rvm use default
$ ruby --version
ruby 2.7.4p191 (2021-07-07 revision a21a3b7d23) [x86_64-linux]
Check if you have all requirements for local environment. To install all development dependencies install Bundler.
gem install bundler
and run next command from root folder:
bundle install
To start Jekyll run:
jekyll serve -w
Site will be available at http://127.0.0.1:4000/ or http://localhost:4000/ (on Windows)
NOTE: in this mode all changes to html and data files will be automatically regenerated, but after changing _config.yml
you have to restart server.
Note: You need to install Node.js
To watch changes of .sass
files and compile it to the .css
on a fly change property safe: true
to safe: false
in _config.yml
.
Note: It works only on local machine, because GitHub runs Jekyll in --save
mode
You can optimize images and minify css and javascript automatically (for now only on Windows).
But for Mac OS users available amazing tool - imageoptim. Thanks @raphaelsavina for link.
Optimize all images by running this script from /automation/images/
folder:
all_image_optimization.bat -d -jtran -pout -pquant -optip -gsicle -svgo
To minify CSS and JS run minify_js.bat
(for Windows) and minify_js.sh
(for Linux and MacOS) from /automation/minifying/
folder:
minify_js.bat
Learn more about available optimization options from the original Zeppelin template's documentation.
_posts/
folder.YYYY-MM-DD-title-here.markdown
---
layout: post
title: "Post title goes here!"
date: 2019-03-25 12:38:00
isStaticPost: false
---
Actual post content goes here. Note the date above should match the filename.
index.html
file located in the root folder. E.g. to disable the 'Rockstar Speakers' block simply remove the line: {% include rockstar-speakers.html %}
_config.yml
file located in the root folder. E.g. to edit the 'About' block, edit the section:# About Block
aboutTitle: "About ResBaz Auckland"
aboutSubtitle: "Conference"
aboutText: "<p>The Research Bazaar is a worldwide festival promoting the digital literacy emerging at the center of modern research. Throughout 2019, events will be held at a number of university campuses around the globe.</p>
_config.yml
are visible._data/sessions.yml
._data/schedule.yml
file._data/sessions.yml
has been referenced in _data/schedule.yml
, it will still appear in the 'Schedule' page.-
id: 007
title: "Crash course in Pen Testing"
description: "Learn the basics of pen testing. Martinis provided."
subtype: workshop
speakers: [4, 5, 6]
complexity: "Beginner"
presentation: "https://link-to-any-resources.com/resource.pdf"
complexity
, presentation
, and subtype
fields are all optional.speakers
field references the ID of speakers, listed in the _data/speakers.yml
file._data/speakers.yml
.-
id: 4
name: "Sam"
surname: "Kavanagh"
company: "Centre for eResearch"
title: "eResearch Engagement Specialist"
bio: "Sam is a member of the Centre for eResearch's engagement team and is teaching the LaTeX workshop."
thumbnailUrl: "sam_kavanagh.jpg"
rockstar: true
ribbon:
- {abbr: "CeR", title: "Centre for eResearch", url: "https://eresearch.auckland.ac.nz"}
social:
- {name: "github", link: "https://github.com/Hganavak"}
rockstar
field determines whether a speaker appears in the Rockstar Speakers
block on the homepagethumbnailURL
, ribbon
, and social
fields are all optional_data/schedule.yml
.-
date: "2019-07-10"
dateReadable: "July 10"
tracks:
- {title: "Stream 1", color: "#90be4e"}
- {title: "Stream 2", color: "#03a9f4"}
- {title: "Stream 3", color: "#e91e63"}
- {title: "Stream 4", color: "#FF00FF"}
timeslots:
- {
startTime: "10:00",
endTime: "10:45",
sessionIds: [002, 404, 002, 001]
}
- {
startTime: "11:00",
endTime: "11:45",
sessionIds: [404, 404, 404, 001]
}
- {
startTime: "12:00",
endTime: "11:45",
sessionIds: [307]
}
-
404
is used to specify that there is nothing on in this timeslot._data/sessions.yml
which are used to specify lunch/coffee breaks, by default these have the IDs 503
and 307
respectively.11-11:45
there would be no talks for Stream 1-3
, and the item with the ID 001
specified in _data/sessions.yml
would appear in Stream 4
.Project is published under the MIT license. Feel free to clone and modify repo as you want, but don't forget to add reference to authors.
The original creators of the Zeppelin template also ask that you contact them when your site is live as they maintain a gallery/list of their template instances.