This website is created by Helmholtz HZI to support the open collaboration of researchers around COVID-19.
For any issues with the site including typos or rendering issues, please file an issue or send a pull request. The site automatically deploys once pull requests are merged.
To contribute content, you can create a Pull Request with the content.
An excellent place to learn about contributing science related blog posts is ropensci technical guidelines.
If you would like to add a researcher, the general content steps are taken but instead of generating files with markdown you amend the Researcher list.
For changes to the website, there are a few key areas:
{{ partial "leaflet.html" . }}
-- these are sub-templates and are found in layouts/partialsThe default site (en):
content/publication
contains the reference to scientific papers. It's our main folder to curate publications!.md
refers to one scientific paper, and is named by its DOI, e.g. 10.1101-2020.05.18.20103283.md
content/publication/biorxiv/10.1101-2020.05.18.20103283.md
The language-specific sites (e.g. de):
config.toml
each language (except en
) has an additional content folder defined, e.g. contentDir="content_de"
for the German site. cp content/publication/biorxiv content_de/publication/biorxiv
git clone --recurse-submodules git@github.com:hzi-braunschweig/serohub.git
git clone --recurse-submodules git@github.com:<your account>/serohub.git
git remote add upstream https://github.com/hzi-braunschweig/serohub.git
We use a theme hugo-infinite as the basis for the site. The --recurse-submodules
argument in git clone
will have established a connection. You should not make changes to contents in the submodule instead, you should copy files from the themes structure and paste them into the corresponding section of the main repository and edit it there. You only work with the submodule contents directly if you want to fix a bug and that is best done with a fresh fork of the theme directly from the theme's repository.
From inside the website directory, run hugo serve
to get a live local copy (typically on http://localhost:1313) that will update whenever you make changes.
We will host the solution on Netlify with the source files hosted on GitHub. This will enable HZI researchers to work in an open way and accept collaborations from others.
This website uses Hugo. To work with Hugo locally, you will need to install it.
Hugo is a website generator that pre-generates web pages so that they can be hosted very cheaply. It is used by a significant amount of the research and science communities due to its excellent support for markdown which enables researchers to use literate programming techniques in R and Python to interleave analysis and text.
The website is hosted on Netlify.
The website is automatically updated everytime there is a change to the master branch in GitHub. Additionally, any pull requests or branches will also have preview URLs built. The preview links for Pull Requests will be included in the Pull Request interface on GitHub.
The Netlify hosting has Visitor access > OAuth authentication enabled with a GitHub OAuth application - this is important for the Netlify CMS to support open authoring.
Netlify can support custom SSL certificates to be associated with the intended domain of serohub.helmholtz-hzi.de
The SSL can either be a letsencrypt managed certificate or it can support a wildcard domain SSL. Note that the custom certificate route requires the SSL certificate to be updated manually, whenever a new one is issued.
The user interface for adding and managing studies is built using the Netlify CMS.
The CMS is used to provide an interface to GitHub and Git activities behind the scenes. You can login with your Github account at serohub.netlify.app/admin. Please note,
Failed to persist entry: API_ERROR: Not Found
when trying to save a new blog entry.