IAM Lab website

This website is powered by Academic Kickstart for Hugo. Check the docs for adding new modules or updating the template. Its source code is hosted on the IAM Lab GitHub organisation. The compiled website is hosted on Netlify with continuous integration, Simon will have the password to the lab's Netlify account in case you need to check the deployment logs if your changes broke the website.

Before adding an image

Optimise every image to keep the website light and fast using https://bulkresizephotos.com. Choose your image, go to File Size and set the size slider to 100kb or less. You can also use that website to resize your images.

Correct typos

You can use GitHub's GUI to correct any typos. Go to the file you want to modify, for example, Alan's profile and click on the pencil icon on the right. Once your changes are done, add a commit title (for example, "Add new affiliation for Alan") and optionally a description, then click Commit changes. The site will deploy itself, and you should see your changes online within ~30 sec.

Add/Modify/Delete new people, project, sections, news

First, set up your dev environment:

1. git clone https://github.com/IAM-lab/website_iam.git iam_website
2. cd iam_website
3. git submodule update --init --recursive
4. git pull
5. Download Hugo Extended for your platform and copy the relevant binary to the root of your iam_website folder
6. Run hugo serve at the root of iam_website, if everything went well you should see the website in localhost:1313

Once you have done any changes outlined below, push them to the repo and they will be automatically deployed:

1. git add .
2. git commit -m "MEANINGFUL message please"
3. git push

Add People

1. Go to iam_website/content/authors
2. Copy and paste Julio-Vega folder with the name of the new person replacing spaces with dashes (for example Jane-Doe).
3. Change:
   • name
   • authors (this value has to match the folder name without dashes)
   • leave superuser as false
   • role
   • organizations
   • bio (1 or 2 sentences)
   • interests (keywords)
   • education
   • social links (you can use font awesome icons but choose the right icon pack)
   • ignore email
   • set user_groups the group you want this person to belong to in People (available groups are in user_groups in content/home/people.md)
4. Add a profile image named avatar.png or avatar.jpg to this person's folder.
5. Your file structure should be something like:
   • content/authors/Jane-Doe/_index.md
   • content/authors/Jane-Doe/avatar.jpg

Modify People

Just modify their _index.md file.

Delete People

Just delete their folder.

Add Projects

1. In your iam_website folder execute hugo new --kind project project/my-project-name
2. Just as with people, edit the newly created file content/project/my-project-name.md.
3. If you want to link a project to people in the lab, add a field authors within the two +++. For example authors = ["Jonathan Carlton", "Andy Brown", "Caroline Jay"]
4. You can link the project to an external website by setting the external_link: "http://external-project.com" variable (our internal page will be ignored)
5. You can add a project image named featured.png or featured.jpg to the project's folder.
6. You can add a longer project description below the final +++.

Modify Projects

Just modify its index.md file.

Delete Projects

Just delete its folder.

Add News

1. In your iam_website folder execute hugo new --kind post post/my-article-name
2. You can add a news image named featured.png or featured.jpg to the news' folder.
3. Feel free to add tags and categories to its index.md file. The former will show up on the lab's world cloud, and the latter work as filters (try browsing cs.iam-lab/categories/your-category)
4. Make sure you link your news to a project by setting projects = ["project-folder"]

Modify News

Just modify its index.md file.

Delete News

Just delete its folder.

Add Publications

There are two ways of adding publications, one for permanent and one for temporary staff.

For permanent staff add to bibliography/dblp-ids.txt their dblp PID resource URI with a .bib extension followed by a pipe | followed by their name as it appears in their publications: https://dblp.org/pid/h/SimonHarper.bib|Simon Harper. A python script, download_bib.py, takes those URIs and downloads the respective bib files. It uses the name after | to make sure all bib entries belong to this author (in case of errors on dblp). Why do we use dblp? Because it exposes curated bib files for free and without restrictions, having consistent bib keys allows us to ignore duplicates automatically.

For temporary people (e.g. PhD students) it is best to add individual bib files to the folder bibliography/bib. Be careful with duplicates, the website won't detect if two papers are the same if they have different bib keys. This option is ideal for adding papers not indexed by dblp or not co-authored by permanent staff.

In any case, download_bib.py reads the dblp and individual bib files and executes Academic Admin to import all bib entries automatically. download_bib.py is executed on Netlify's servers after every push to the website's git repo. The bash command to do so is set in line 2 of netlify.toml, Academic Admin is installed from requirements.txt and the Python interpreter is set in runtime.txt.

Modify Publications

If you want to modify papers downloaded from dblp, you would need to modify the parsed bib entry between lines 30 and 31 of download_bib.py before it is appended to db.entries. If you want to modify papers of non-permanent staff just edit their individual bib files in bibliography/bib.

Delete Publications

If you want to get rid of specific papers downloaded from dblp, add their bibkeys to ignore_files_from_dblp in line 13 of download_bib.py. If you want to get rid of papers of non-permanent staff, just delete them from their individual bib files in bibliography/bib.