Site Overview

This site is running a version of the Academic Hugo Theme/system. This post provides an overview on how to contribute to the site and how the site can be used to support the research organization. (This content also appears in the README.md file.)

How to contribute to website development?

Clone repo and submodules

git clone https://github.com/bcCOVID-19group/bcCOVID-19group-site.git
git submodule update --init --recursive

The submodule command should only need to be run once after cloning.

Use git

  • Make changes in a branch. Push to GitHub. Pull request.
  • Deployments are handled by Netlify.
  • Branches are available for preview before merging pull requests.

screencap

How does the research organization work?

This site is designed to support a team of people (called authors) to collaborate on projects while producing outputs (posts, talks, publications) that can be shared on the web. The content is developed in Markdown (and potentially R Markdown) files with YAML top matter.

Team

The authors (subdirectory of content) has a tree structure that looks like this:

authors
├── admin
│   ├── _index.md
│   ├── avatar.png
│   └── old_avatar.jpg
├── carolinecolijn
│   ├── _index.md
│   └── avatar.jpg
├── colliand
│   ├── _index.md
│   └── avatar.jpg
├── dancoombs
│   ├── _index.md
│   └── avatar.jpg
└── ianabc
    ├── _index.md
    └── avatar.jpg

5 directories, 11 files

The file _index.md inside _carolinecolijn controls the content that appears on this person’s page. (Author pages for other members of the Group need to be created.)

The people in the site can belong to groups (Researchers, Support) and are sorted accordingly on the Team page.

Projects

The files in the project directory describe a project for the Group. While carrying out work on a project, collaborators will generate outputs (posts, talks, publications).

Outputs

  • Posts
  • Talks
  • Publications
Avatar
James Colliander
PIMS Director

Related