lr-vu / site

https://lr.cs.vu.nl/

This repo hosts the source code of the website. It's built with Jekyll. This README is an onboarding document. If you find anything to be updated, including this README, please make a branch and a pull request (PR). If your Github account is not added here, ask people around you to add you.

By building a website with Jekyll and hosting as a Github page, we don't have to worry about traditional web development. Ideally, we only have to modify markdown files.

Although at the moment some people are more active in the web development, anyone can make changes / contributions by creating a branch and making a PR to the main branch. For example, adding / modifying your profile can be easily done by you.

Prerequisites

1. Install Ruby, Jekyll, and Bundler
2. In the root repo directory, install the necessary gems by running bundle install.

Run the website locally

1. Run bundle exec jekyll serve --baseurl /
2. Type http://127.0.0.1:4000/ on your web browser.

Adding or modifying a user profile at https://lr.cs.vu.nl/about/people

The correct way

1. Clone this repo by running git clone https://github.com/lr-vu/site.git
2. Create a new branch (e.g., git checkout -b add-bob)
3. Add your profile image in ./images/people/.
4. Add your entry in ./_data/people.yaml. The names are ordered in an alphabetical order.
5. Test locally if it works.
6. Push your code to Github (e.g., git push --set-upstream origin add-bob)
7. Create a PR to the main branch. Add reviewers who can check your code (e.g., Taewoon Kim).
8. After the PR is merged, see if it works here.

The easy way

1. Add your profile image here, by clicking the button "Add file/Upload files"
2. Add your entry here, by clicking pencil icon button. The names are ordered in an alphabetical order.
3. See if it works here. You might have to wait a few minutes. Trying in incognito mode shows faster results.

Adding or modifying a project at https://lr.cs.vu.nl/research

See ./research/index.md.

Adding or modifying news at https://lr.cs.vu.nl/

We write short news in one or two sentences, which appear at the bottom of our landing page. At the moment this is manually added by modifying this file.

In the (near) future, we'll make a separate file for the news.

Adding or modifying a publications at https://lr.cs.vu.nl/research/publications

First, join our Zotero group. Ask people around you to accept your join request. Our publications are all maintained in the Zotero library. If you have your DOI ready, click "Add by Identifier". Otherwise add your pulibcation manually by clicking the icon "New Item".

Once you've added your publication, our Github Action will update it to the website. This might take an hour. If you are impatient, you can run the workflow manually.