Update website

[zkamvar]

The website for epicontacts is sorely out-of-date. For example, the CRAN version has edges_pal() included in the documentation for colors, but it is missing on the website: http://www.repidemicsconsortium.org/epicontacts/reference/colors.html

It becomes a bit awkward to do this because the repo has added features since the last CRAN update, though.

[vpnagraj]

i guess the v1.1.2 release (https://github.com/reconhub/epicontacts/issues/124) is as good a time as any to update the website :)

just pushed a rebuild and have a PR at https://github.com/reconhub/epicontacts/pull/127

@finlaycampbell @thibautjombart please merge if looks good to you !

not sure how the RECON site hosting is set up at this point (GH pages? Netlify?) ... but i'm assuming once the freshly built pkgdown site is on main branch then the changes will be live.

any thoughts on setting up a GH action to automate the pkgdown site build? i've had success with that sort of setup elsewhere

don't want to add unnecessary complexity. food for thought.

[thibautjombart]

Thanks for the update! I actually had to check as was no longer sure how the website is deployed. It is indeed a GH page where sources of the website are taken from the docs/ folder in the master branch. All packages on reconhub which have a website follow the same process, and pages are served on our DNS: www.repidemicsconsortium.org/[pkg_name].

I have also played with github actions and I agree setting up automation for the pkgdown website would be great. Doing it for epicontacts would probably set a precedent for other packages, which would be awesome.

How did you want to trigger new builds? I can imagine a few approaches:

1. commits pushed to master/main then trigger build and push on a separate branch (will need shifting the changes to docs/ to a new branch e.g. gh-pages)
2. periodic builds, e.g. weekly
3. builds on new releases; I personally have not tried this one but it seems to be working: https://docs.github.com/en/actions/learn-github-actions/events-that-trigger-workflows

What do you think? Also tagging @TimTaylor @finlaycampbell for awareness / input.

[vpnagraj]

awesome! thanks for digging into the current deployment details.

i guess my thought is that if we consider the master/main branch to be the home of the "stable" version of the package (although not necessarily exactly the same as the CRAN release) ... then option # 1 seems like the most sensible. and that's the workflow i have used for this sort of thing previously.

let me know if you @thibautjombart or others would prefer to take a crack at writing that GH action.

[thibautjombart]

Option 1 sounds good to me too. Please go ahead, happy to review the PR :)

[vpnagraj]

@thibautjombart ... i just opened a PR with a GitHub action to automate the pkgdown site build and deploy to a gh-pages branch:

https://github.com/reconhub/epicontacts/pull/128

same setup i've used elsewhere:

https://github.com/vpnagraj/twoxtwo/blob/main/.github/workflows/pkgdown.yaml

https://github.com/vpnagraj/twoxtwo/tree/gh-pages

keep in mind that the automation only triggers on push to main/master branch. also heads up that the system dependencies (https://github.com/reconhub/epicontacts/blob/pkgdown-gh-action/.github/workflows/pkgdown.yaml#L23) might need some attention. but you'll get a sense of that after the first build is triggered. i would manually kick it off to test but i'm not seeing the automation in the "Actions" UI yet. maybe an org permissions thing? or because it hasn't made it's way onto main/master yet?

hope this helps! give me a shout if you need a hand with anything else.

[thibautjombart]

Looks good, I guess we should merge and give it a test. Maybe consider adding a manual trigger by adding workflow_dispatch: e.g. https://github.com/whocov/trend_analysis_public/blob/bd096c5f44938d876c14ae794882f27ab8e70075/.github/workflows/auto_update_afro.yml#L9