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.
- Install Ruby, Jekyll, and Bundler
- In the root repo directory, install the necessary gems by running
bundle install
.
- Run
bundle exec jekyll serve --baseurl /
- Type http://127.0.0.1:4000/ on your web browser.
Adding or modifying a user profile at https://lr.cs.vu.nl/people/
The correct way
- Clone this repo by running
git clone https://github.com/lr-vu/site.git
- Create a new branch (e.g.,
git checkout -b add-bob
) - Add your profile image in
./images/members/
. - Add your entry in
./_data/members.yml
. The names are ordered in an alphabetical order. - Test locally if it works.
- Push your code to Github (e.g.,
git push --set-upstream origin add-bob
) - Create a PR to the main branch. Add reviewers who can check your code (e.g., Taewoon Kim).
- After the PR is merged, see if it works here.
The easy way
Adding or modifying a project at https://lr.cs.vu.nl/projects/
This is the same as Adding or modifying a user profile, except that the paths that
contain members
should be replaced with projects
.