- Install Hugo, extended edition.
- Clone this repo
git clone --recurse-submodules -j8 https://github.com/KumarRobotics/kr_website.git hugo server -D --disableFastRender
The website should be available at http://localhost:1313/.
- Build the website locally. See notes above.
- Modify the website and verify your modifications.
- Submit a PR on Github. Please do not push directly to the
mainbranch.
Content is located in the content/ folder. Images are in static/.
After submitting a PR, there are a few checks that are performed:
The Lint workflow run on every pull
request (and locally with python3 scripts/check_images.py) enforces:
- Member photos (
static/img/group/current/) must be exactly 600x600 px and at most 500 KB. - Every image referenced in
content/,data/orlayouts/must exist understatic/.
The website is deployed to Pantheon (static hosting via the Empty Upstream)
with the deploy-pantheon workflow:
- Push to
devbuilds the site and deploys it to the Test environment. - Push to
mainbuilds the site and deploys it through Test to Live.