This repository hosts the Autonomous Driving Lab homepage. The homepage is implemented using Jekyll, which generates static web site based on HTML templates and Markdown content files. It is hosted by GitHub Pages, which means that every time you commit something to the repository, the homepage is automatically updated. To get permission to edit the content send your GitHub account name to adl@ut.ee.
Few links to get started with Jekyll:
- Step by Step Tutorial gives concise overview of the Jekyll basics. Recommended read.
- Liquid template language is used in Jekyll HTML template files.
- kramdown flavor of Markdown is used for some of the content.
Quickstart regarding the content:
- To change menus edit _data/navigation.yml.
- To change the list of news articles and videos edit _data/media.yml.
- To change the team members edit _data/team.yml.
- To add new research papers edit _data/research-papers.yml.
- To change the list of courses edit _data/courses.yml.
- To add new thesis topics edit _data/thesis-topics.yml.
- To add new defended theses edit _data/defended-theses.yml.
- To change the research area descriptions edit one of the Markdown files in _research-areas.
- To add new project add new Markdown file to _projects.
- To add new blog post add new Markdown file to _posts.
More details about those files in the sections below.
It is easiest to change single files through GitHub web interface. One advantage of this is that the basic Markdown preview functionality works. For more complicated changes including multiple files the repository should be cloned locally so that local preview can be used. To run local preview on Ubuntu:
- Install system dependencies with
sudo apt-get install ruby-full build-essential zlib1g-dev
. - Install Jekyll dependencies with
bundler install
in repository directory whereGemfile
is. - Run
bundler exec jekyll serve
in the repository directory and open http://localhost:4000/ in browser.
Navigation refers to the menus and site map in the page footer. It is implemented as data file _data/navigation.yml. The menu items can have following attributes:
page
- title of the menu item.url
- (relative) address of the page.prefix
- menu item is active if the URL contains this string. Used only for the main menu.
Media includes links to articles and videos and is used to generate the Media page. It is implemented as data file _data/media.yml. This file contains the list of links, each of the links can have following attributes:
type
- eithervideo
orarticle
. Three latest videos are shown at the beginning of the page.url
- link to the article or video.image
- image to use with the link. Currently used only with videos. Hint: you can use Youtube thumbnail link here, see this.language
- eitheree
oren
. Articles can be filtered by this on the web page.date
- when the article was published. Articles are shown in descending order. Date must use format YYYY-MM-DD.title
- title of the link.
Team includes the team members used to generate the Meet our team page. It is implemented as data file _data/team.yml. This file contains the list of people, each can have following attributes:
name
- name of the person.position
- position of the person.group
- eitherlead
,team lead
,engineer
orstudent
.email
- e-mail of the person.image
- photo of the person. The photos should be put to images/team
Research papers are shown under the Publications and also filtered list is shown under each Research area. It is implemented as data file _data/research-papers.yml. This file contains the list of papers, each can have following attributes:
title
- title of the paper.conference
- short name of the conference, journal or other publication venue.research_area
- title of research area, e.g.Behavior prediction
,Motion planning
,Learned driving
,Human-vehicle interaction
,Security
, etc. Used for filtering the papers under each research area. NB! Pay attention to casing and spaces!authors
- list of authors. Format is comma separated full names.year
- publication year.link
- link to the paper.website
- optional link to the website.github
- optional link to the GitHub page.file
- optional link to supplementary files.video
- optional link to video.
List of courses shown under the Courses page. It is implemented as data file _data/courses.yml. This file contains the list of courses, each can have following attributes:
type
- one ofIntroductory course
,Related subtasks
orRelated fields
. Used for grouping the courses.title
- title of the course.code
- SIS code of the course.spicyness
- number of cars displayed next to the course, can be 1-3.ects
- number of credits.lecturer
- name of the lecturer.link
- link to the Study Information System.description
- short description of the course and its relationship to ADL.
List of thesis topics is shown on the Thesis topics page. It is implemented as data file _data/thesis-topics.yml. This file contains the list of topics, each can have following attributes:
title
- title of the thesis topic.description
- short descriptions of the thesis topic.type
- name of the research area, e.g.Behavior prediction
,High-definition maps
,Localization
, etc.availability
- thesis topic availability:BSc
- available to bachelor students,yes
orno
MSc
- available to master students,yes
orno
PhD
- available to PhD students,yes
orno
leads
- supervisors of the thesis, can be multiple:name
- name of the supervisor.email
- e-mail of the supervisor.
file
- optional link to more elaborate description, e.g. from ATI thesis offers site.
List of defended theses shown on the Defended theses page. It is implemented as data file _data/defended-theses.yml. This file contains the list of theses, each can have following attributes:
title
- title of the thesis.supervisor
- supervisor or supervisors of the thesis, comma separated list of full names.research_area
- name of the research area, e.g.Autonomy software
,High-definition maps
,Learned driving
,Perception uncertainty
,Human-vehicle interaction
, etc. Used to filter the theses on research area page. NB! Pay attention to casing and spaces!author
- name of the author.field
- one ofBSc
,MSc
orPhD
.year
- when the thesis was defended.link
- link to the thesis text, e.g. from ATI thesis site.
Research areas are implemented as collection in _research-areas directory. The content is in Markdown files, but within Markdown file HTML can also be used. Each of the files includes front matter with following attributes:
layout
- must beresearch-area
.title
- title of the page.icon
- pictogram of the research area used on the Research areas page.research_lead
- name of the research lead.lead_image
- photo of the research lead.lead_description
- position of the research lead.lead_email
- e-mail of the research lead.webURL
- optional link for the group or research lead homepage.twitter
- optional link for the group or research lead Twitter page.facebook
- optional link for the group or research lead Facebook page.instagram
- optional link for the group or research lead Instagram page.
Projects are implemented as collection in _projects directory. The content is in Markdown files, but within Markdown file HTML can also be used. Each of the files includes front matter with following attributes:
layout
- must beproject
.title
- title of the page.category
- not used.webURL
- optional link to the project web page.twitter
- optional link to the project Twitter page.facebook
- optional link to the project Facebook page.instagram
- optional link to the project Instagram page.
Blog is implemented as usual Jekyll blogging functionality in _posts directory. The content is in Markdown files, but within Markdown file HTML can also be used. The files must be named in format YYYY-MM-DD-title.md
. Each of the files includes front matter with following attributes:
layout
- must beblogpost
.title
- title of the post.date
- date of the post in YYYY-MM-DD format.image
- main image of the post, will be shown on the front page and as the first thing on blog post page.alt
- textual description of the image.permalink
- must be/blog/:title/
meta
- description of the page in meta taglanguage
- eitheree
oren
. Blog posts can be filtered by this.author
- name of the author of the post.