Editing the Club's website
This website is powered the Academic theme for Hugo. The documentation they provide is quite extensive, so we summarize some of the important features relevant to the current website and present workflow ideas on how to update the website.
Hugo and Markdown
While the website consists of html source interpreted by the visitor’s browser, its content is generated from Markdown. Hugo acts as an interpreter and compiler: it translates the file structure, the Markdown files and some configuration files (yaml or toml) into the html files visible to the visitor.
Repository description
The website is hosted on GitHub Pages. The static contents of the website appears in the docs folder of the UmichStatistics GitHub organization repository ComputingClub. The other folders and files of the repository are used to generate the website: only the docs folder is necessary for the static website to be operational.
Deployment
Any change in the files outside of the docs folder will not affect the public website. In order for the changes to become public, it is necessary to deploy the website, i.e. to use Hugo to update the files in docs. Hence, anyone updating the website needs to run Hugo for the changes to appear. More details in Deployment
The maintainers are currently considerings ways to automatically deploy the website upon a push to the repository. More to come…