MoST Website

This repository contains the sources of MoST research unit website. We're a research unit of the Digital Society center at Fondazione Bruno Kessler in Trento, Italy.

Deployment Location

In its current form, the website is deployed at the following URL:

https://fbk-most.github.io/

When it will be ready for production, it will also be available at:

https://most.fbk.eu/

Content Management

The website is managed by the members of the research unit. To modify the website, you need to clone the repository first:

git clone [email protected]:fbk-most/fbk-most.github.io

Ensure you start working from the main branch:

git checkout main

Create a new working branch:

git checkout -b doc/my-change-name

(Please, replace my-change-name with a meaningful name for your change, otherwise you will make weeping angels cry, which is not a good thing.)

Edit the website according to the changes you want to add. Once you're done, commit and push the changes:

git add .
git commit -m "My commit message"
git push -u origin doc/my-change-name

Finally, open a pull request on GitHub and ask for a review. The pull request contains automatic checks to ensure that the changes, once deployed, would not break the website. Once the pull request has been merged the website will be automatically deployed and updated.

Adding a New Team Member

Create a new markdown file in the _people directory with the following front matter:

---
layout: page
name: "Full Name"
position: "Job Title"
status: "current" # or "alumni" or "visitor"
image: "/assets/images/people/filename.jpg" # optional
website: "https://example.com" # optional
twitter: "username" # optional
github: "username" # optional
scholar: "id" # optional Google Scholar ID
---

Brief bio goes here.

<!--more--> <!-- excerpt separator -->

Extended bio and information goes here.

Make sure you add the corresponding image to the assets/images/people directory. Note that, in general, splitting the name and the surname of people consistently is complex across cultures. For this reason, we chose to let each member to choose how they want their full name to be written (on the file system and using UTF-8) as long as each name component is separated by a dash character (i.e., -). The name used in the filesystem inside _people maps to the URL that uniquely identifies the new team member.

The <!--more--> tag is used to separate the excerpt shown as a preview from the full post content shown when the post is opened.

Adding a News Post

Create a new markdown file in the _posts directory with the filename format YYYY-MM-DD-title.md and the following front matter:

---
layout: page
title: "Post Title"
date: YYYY-MM-DD
categories: category-name
excerpt_separator: <!--more-->
---

Brief excerpt goes here.

<!--more-->

Full post content goes here.

The <!--more--> tag is used to separate the excerpt shown as a preview from the full post content shown when the post is opened.

Getting Help

If you run into trouble, @bassosimone is here to help! (Insert here obligatory Doctor Who quote.)

Testing Changes Locally

Install Docker Compose using the official instructions published on the Docker website.

Then, run the following command to start a local server:

docker-compose up

and follow the instructions printed on the screen, including the URL of the locally-running website, which should be http://127.0.0.1:4000/.

Architecture

This repository contains a pretty standard Jekyll website. The website is hosted on GitHub Pages and is automatically built whenever a pull request is merged into the main branch.

The following directories are of interest:

• _includes/home: content included into the home page.

• _includes/shared: content shared across multiple pages.

• _layouts/base.html: the base layout for all pages.

• _layouts/home.html: the layout for the home page.

• _layouts/page.html: the layout for all other pages.

• _people: information about the people in the research unit, including current members, alumni, and visitors.

• _posts: blog posts.

• assets/css: CSS files.

• assets/img: images.

• assets/js: JavaScript files.

• assets/vendor: vendored dependencies.

• _config.yml: configuration file for Jekyll.

• index.md: the home page.

• news.md: the news page containing blog posts.

• people.md: the people page.

When building the website, Jekyll will generate the content of the news and people pages automatically.

License

This website is licensed under the Creative Commons Attribution-ShareAlike 4.0 International License.