11# Delphi Website
22
3+ [ ![ Open in Gitpod] ( https://gitpod.io/button/open-in-gitpod.svg )] ( https://gitpod.io/#https://github.com/cmu-delpih/www-main )
4+
5+
36Delphi's homepage at https://cmu-delphi-main.netlify.app/
47
58This site is based on [ Hugo] ( https://gohugo.io ) and uses [ Prettier] ( https://prettier.io ) for formatting.
@@ -38,9 +41,9 @@ In RMarkdown things are slightly more different since the R Markdown parser is u
3841** Examples**
3942
4043```
41- [Facebook]( `r blogdown::shortcode_html("ref ", "2020-08-26-fb-survey")`)
42- [previous exploratory investigations]( `r blogdown::shortcode_html("ref ", "2020-08-26-fb-survey#some-interesting-examples")`)
43- [public API]( `r blogdown::shortcode_html("apiref ", "api/covidcast.html")`)
44+ `r blogdown::shortcode_html("reflink ", "2020-08-26-fb-survey", "Facebook")`
45+ `r blogdown::shortcode_html("reflink ", "2020-08-26-fb-survey#some-interesting-examples", "previous exploratory investigations")`
46+ `r blogdown::shortcode_html("apireflink ", "api/covidcast.html", "public API")`
4447
4548```
4649
@@ -53,6 +56,8 @@ In addition, there in the `/data` directory there are the following listings in
5356
5457## Development Environment
5558
59+ One click: [ ![ Open in Gitpod] ( https://gitpod.io/button/open-in-gitpod.svg )] ( https://gitpod.io/#https://github.com/cmu-delpih/www-main )
60+
5661### Web Editor Only
5762
58631 . Install Node: https://nodejs.org/en/download/
@@ -86,6 +91,7 @@ In order to convert the Rmd files to HTML files for Hugo you also need to:
8691 - ` local=TRUE ` similar to ` -D ` to process draft files
8792 - ` run_hugo=FALSE ` to manually run hugo
8893 - ` build_rmd=TRUE ` force a (re)build of the Rmd pages
94+ 1 . Run blogdown to convert a single file to HTML: ` Rscript -e 'blogdown::build_site(local=TRUE, run_hugo=FALSE, build_rmd="content/blog/<NAME>.Rmd")' `
89951 . Alternatively, run ` npm run build:blog `
90961 . Run Hugo server as usual
9197
@@ -98,3 +104,16 @@ In case you use new dependencies don't forget to either edit `environment.yml` o
98104A Github action should runs when Rmd files changes so it will verify that the blog post can be built.
99105However, the converted HTML file along with all generated images are committed to the repository.
100106This simplifies the deployment and ensures that we have a blog post even when the API or data changes.
107+
108+
109+ ### Release Process
110+
111+ The release process is based on [ release-it] ( https://github.com/release-it/release-it ) . To create a release, run
112+
113+ 1 . create/checkout the release branch ` release ` and push to origin
114+ 1 . run ` npm run release ` and publish the release
115+ 1 . create a PR that merges the ` release ` branch in the ` main ` branch
116+ 1 . create a PR that merges the ` main ` branch back into the ` dev ` branch
117+
118+ Then go to the release page and update short description of the changes made.
119+
0 commit comments