For developers - SydneyBioX/SC_CPC_workshop GitHub Wiki
Welcome to SC_CPC_workshop
! I (Kevin) really appreciate your contributions to this project and help me in experimenting with the Google Cloud!
Basic changes by a workshop developer
As a member of SydneyBioX
, you should be able to make commits and push to SydneyBioX/SC_CPC_workshop
. If you want to contribute to the workshop, you need to:
- Make local changes to
.Rmd
and locally build the website viarmarkdown::render_site()
when are at the root directory. - Commit and push.
And that is it! The push to SydneyBioX/SC_CPC_workshop
will then trigger a new Docker build in Google Cloud, you do not have to worry about anything.
Making advanced changes
Say, during one of your updates, you realised that:
- you wanted to use a new package: then just add an extra line of installation instruction in
install.R
. - you wanted to add a new dataset: then just place the data in the
data/
folder and notify Kevin.
Any other more advanced changes should go through Kevin (or whoever the workshop administrator). This is because these changes will likely involve a reconfiguration of the Google Cloud pipeline.
A major advantage of this pipeline is that you should be able to just make contributions to this workshop and let whoever is in charge worry about the deployment issues.