This is the ISSLab Group Web Site, built with Jekyll and bibble. It's based on research group website template. Thanks to Sampa for sharing their amazing work. This work is licensed under a Creative Commons Attribution-NonCommercial 4.0 International License.
The requirements for building the site are:
- Jekyll: run
gem install jekyll - bibble: run
pip install bibble - ssh and rsync, only if you want to deploy directly.
Clone the repo to your own machine: git clone https://github.com/isslabs/isslabs.github.io.git make compiles the bibliography and the website content to the _site directory. To preview the site, run jekyll serve and head to http://0.0.0.0:5000 or the url shown in your terminal.
When all the changes have been done copy the content of the _site folder, change to master branch and replace all the content. I strongly recommend to run a local server to make sure all the changes are in the page. Then you can push your changes in both branches to the repo.
Start with the _config.yml file, where you enter the name of the site and its URL. Keep adding content. See below for instructions for each of the various sections.
The list of publications is in bib/pubs.bib. Typing make will generate pubs.html, which contains a pretty, sorted HTML-formatted list of papers. The public page, publications.html, also has a link to download the original BibTeX.
If you want to add a new publication to the page just copy the paper/journal bibtex content into bib/pubs.bib. Jekyll and Jekyll-scholar will do all the magic and will generate a new entry.
However, there are some important things to check before pushing your changes:
- New publications bibtex key must be meaninfull, we recommend to use:
<firstLastnameOfFirstAuthor><Year><toolName|confName|journalName|meaningfulWor>
---
linan2018rip
linares2017cel
rodriguez2018mutode
- If the bibtex has the keyworks tag and its content its to long its better to remove it because bibtex link in webpage generates a div whose height is based on the number of lines of the bibtex, if the keywords are too long the layout breaks.
The filter over the publications is done in the publications.html file. In case you want to change something.
For both long-form blog posts and short news updates, we use Jekyll's blogging system. To post a new item of either type, you create a file in the _posts directory using the naming convention YYYY-MM-DD-title-for-url.md. The date part of the filename always matters; the title part is currently only used for full blog posts (but is still required for news updates).
The file must begin with YAML front matter. For news updates, use this:
---
layout: post
shortnews: true
---
For full blog posts, use this format:
---
layout: post
title: "Some Great Title Here"
---
And concoct a page title for your post. The body of the post goes after the --- in either case.
You can also customize the icon that is displayed on the news feed. By default it's newspaper-o. We use icons from the FontAwesome icon set.
News can be found in _posts folder. Everytime you create a news the file must be called like
<year>-<month>-<day>-<newsID>.md
And its content should be something like this:
---
layout: post
title: "ACM SIGSOFT Distinguished Paper Award"
icon: trophy
image: https://upload.wikimedia.org/wikipedia/commons/thumb/8/8e/Association_for_Computing_Machinery_%28ACM%29_logo.svg/300px-Association_for_Computing_Machinery_%28ACM%29_logo.svg.png
shortnews: true
---
Mario Linares-Vásquez received an ACM DPA for his paper "Automatically Assessing Code Understandability: How Far Are We?", in Proceedings of 32nd IEEE/ACM International Conference on Automated Software Engineering (ASE'17), Urbana-Champaign, Illinois, USA, October 30 - November 3, 2017
Depending on the type of news the icon can be:
| Type of news | icon key |
|---|---|
| New published paper | newspaper-o |
| Award | trophy |
| Talk | slideshare |
The amount of news that are shown in the index is defined in the _config.yml using the key front_page_news.
To create a project, just create a markdown file in the _projects folder. Here are the things you can put in the YAML frontmatter:
title:The project title.notitle:Set this totrueif you don't want a title displayed on the project card. Optional.description:The text shown in the project card. It supports markdown.people:The people working on the project. This is a list of keys from the_data/people.ymlfile.layout: projectThis sets the layout of the actual project page. It should be set toproject.image:The URL of an image for the project. This is shown on both th eproject page and the project card. Optional.last-updated:Date in the format ofYYYY-MM-DD. The project cards are sorted by this, most recent first.status: inactiveSet this toinactiveif don't want the project to appear on the front page. Just ignore it otherwise.link:Set this to an external URL if this project has a page somewhere else on the web. If you don't have alink:, then the content of this markdown file (below the YAML frontmatter) will be this project's page.no-link: trueSet this if you just don't want a project page for your project.
title: "Mutation Testing"
description: Mutation Testing is a type of software testing where we mutate (change) certain statements in the source code and check if the test cases are able to find the errors. It is a type of White Box Testing which is mainly used for Unit Testing. The changes in mutant program are kept extremely small, so it does not affect the overall objective of the program. In this moment, we have open projects in NodeJS and Android Framework
people:
- marioLinares
- camiloEscobar
- diegoRodriguez
- collGabrieleBavota
- collMassimiliano
- collDenysPosh
layout: project
image: /img/project-images/mutation.png
---
People is modified in the _data/people.yml. We have 5 posible roles in our research lab:
| Role | Who has this role |
|---|---|
| faculty | Professors |
| grad | Ph.D. and M.S. students |
| ugrad | Undergraduate students |
| collab | External Collaborators |
| alum | Past students of ISSLab |
when a person is added to the people.yml file it must follow the following template:
<id>:
display_name: "<fullName>"
role: "<role>"
image: "/img/people/<imageName>.jpg"
webpage: "<personalPageURL>"
bio: "<description Of Current position>"
Is important to see that if a person do not have a personal page that tag must be ommited. Also, alumni dont use either webpage or bio tag.
The project uses a custom Python tool to build the BibTeX publication list. As a work around we could generate the publication list locally using Make and push the new generated pubs.html to update the page.
The website is deployed automatically by GitHub pages.
To set up deployments on other services, edit the Makefile and look for the lines where HOST and DIR are defined. Change these to the host where your HTML files should be copied to.
To upload a new version of the site via rsync over ssh, type make deploy. A web hook does this automatically when you push to GitHub. Be aware that the Makefile is configured to have rsync delete stray files from the destination directory.
- Imagine - readme
- Software Design Lab - readme