This repository holds the WDAqua website. It uses Jekyll, hosted using Github Pages.
You'll find it easiest to make changes if you have Jekyll running locally so you can test whether the changes work. To do this:
-
Install Ruby 2.3.3 eg using rbenv to manage your Ruby versions
-
Clone the repo:
$ git clone https://github.com/WDAqua/wdaqua.github.io
- Change directory into the new directory that's been made for the repo:
$ cd wdaqua.github.io
- Install jekyll and bundler gems
$ gem install jekyll bundler
- Run Jekyll locally. It will be served at http://localhost:4000/ by default.
$ bundle exec jekyll serve
You can then edit any of the files in wdaqua.github.io and the changes will automatically reflected in the locally served site.
When you've finished making changes, committing to the master branch of the repo will make the changes on the main website. Use a separate branch and a pull request for changes that you want someone else to check.
Student pages are kept as Markdown files within the _students directory. Simply edit that Markdown file to change it. The body of the Markdown file is the description of your project. Recognised metadata is:
| property | description |
|---|---|
| esr | ESR number |
| name | student name |
| project | title of student project |
| image | name of a file in the assets/images/students directory |
| host | host institution, one of athens, bonn, fraunhofer, odi, soton, st-etienne |
| supervisors | list of the names of supervisors; these are used to automatically create links so make sure they match the filename for a supervisor file in the _supervisors directory |
| start-date | date started studies |
| homepage | homepage on your institution site |
| your email address | |
| your twitter handle | |
| github | your github username |
| publications | a list of publication references; these should be keys for publications listed in _data/publications.yml |
Supervisor pages are kept as Markdown files within the _supervisors directory. Simply edit that Markdown file. The body of the Markdown file is your bio. Recognised metadata is:
| property | description |
|---|---|
| name | supervisor name |
| role | supervisor role |
| image | name of a file in the assets/images/students directory |
| host | host institution, one of athens, bonn, fraunhofer, odi, soton, st-etienne |
| students | list of the names of students; these are used to automatically create links so make sure they match the filename for a student file in the _students directory |
| homepage | homepage on your institution site |
| your email address | |
| your twitter handle | |
| github | your github username |
Advisor pages are kept as Markdown files within the _advisors directory. Simply edit that Markdown file. If there's no home page for the advisor, the content can act as their bio. Recognised metadata is:
| property | description |
|---|---|
| name | advisor name |
| role | advisor role |
| image | name of a file in the assets/images/advisors directory |
| host | host institution (unlike for students & supervisors, this can be any string) |
| homepage | homepage on your institution site |
| your email address | |
| your twitter handle | |
| github | your github username |
News/blog pages are kept as Markdown files within the news/_posts directory. Add new files for new items of news, using filenames in the form yyyy-mm-dd-title. Recognised metadata is:
| property | description |
|---|---|
| title | title of the news item |
| image | image for the news item; this is shown in the listing on the main news page |
| summary | a summary for the news item; if this is given then this summary is provided on the main news page and there will also be a separate page with the summary followed by the content of the news item (eg see ESWC Summer School 2016 which is generated from news/_posts/2016-09-10-eswc-summer-school-2016.md) |