University of Leeds Research Computing Website

This is the official repository of the Research Computing Team website from the University of Leeds. It is built using GitHub pages and Jekyll and is based on the Feeling Responsive theme.

You can find the site at arcleeds.github.io. This used to be forwarded to from https://arc.leeds.ac.uk, however, that is now a Wordpress site to be edited via: https://arc.leeds.ac.uk/wp-admin.

Website Structure Philosophy

The way this site has been structured looks to take advantage of Liquid syntax to neatly manage page content without writing lots of HTML. You'll find most of the data that makes up the content to this site within the _data/ directory, with most of the files in the pages directory just including the liquid syntax to load the data.

The blog, changlog and casestudies pages are in the blog format for this Jekyll template. This means to add a post you need to add a new markdown file into the _posts subdirectory in the format of yyyy-mm-dd-articleName-category.

Contributing

Found a bug? Or got a suggestion? We welcome contributions to help make this site and repository better.

Please check out our contributing guidelines to help guide you get started.

As contributors and maintainers to this project, you are expected to abide by our code of conduct which can be found within our contributing guidelines.

Local Development Environment

Anaconda

Using Anaconda environment on Linux. We recommend miniconda if you don't have Anaconda installed already. Please use the supplied environment.yml, which will provide a standised environment.

To create locally:

$ git clone https://github.com/ARCLeeds/arcleeds.github.io.git

$ git checkout -b [YOURBRANCHNAME] # all work should be on this branch

$ conda env create -f environment.yml

To build and test locally

conda activate arcleeds-ghp
jekyll serve --incremental --watch  

If you leave jekyll running these flags allow you to make changes, save and jekyll will rebuild your changes automatically. The generated HTML is located under the _site subfolder for viewing/testing.

If you pull changes from elsewhere, then stop the jekyll serve, delete or move the _site directory and run jekyll serve again to rebuild the _site directory incorporating all the changes pulled from elsewhere.

Using ruby to generate multiple pages

By combining the files

• scripts/generate_service_pages.rb
• _data/service_catalogue.yml
• _layouts/service_template.html

I was able to create one file for each item listed in the data file using the provided template. To do this I used the following ruby command:

ruby scripts/generate_service_pages.rb

Merging your changes

To merge your changes do a pull request.

If you are working against an issue, remember to link your pull request.

Contact us

You can get in touch with the Research Computing Team via our help form.

If you are unable to use our contact form you can email the team via the service desk itservicedesk@leeds.ac.uk