New Workshop: Creation [RC] and Deployment
Certain aspects of the setup for workshops will be different depending on your role. Headers ending in “[RC]” are for Regional Coordinators. Headers without “[RC]” are assumed to be relevant to both RC and workshop teams.
Setup the Workshop [RC]
Fist, let’s go to the bookdown template.
Click on the “Use this template” green button, which is to the right of the title of the repository “bookdown-template”. Then, press the dropdown option: “Create a new repository”, as seen below.
You will be brought to a “Create a new repository” page. Fill out the blanks as seen below. That is, change the owner to “bioinformaticsdotca”, make it public, fill in the repository name and description according to CBW Guidelines.
“Include all branches” does not need to be selected.
This may take a couple seconds to generate. After it loads, you will be brought to a new repository for the new workshop!
Now, let’s turn this into a website - let’s deploy!
Workshop Repo VS Workshop Website
Now, you have made a repository that holds what GitHub needs to make our website (the basic workshop template). Essentially, the template has already been configured so that the HTML files that make up our website go into a folder called docs. We need to tell GitHub to look at the docs folder to find our website files and make it available to see online (a.k.a deploy it). This is what we mean when we say CBW uses GitHub pages to deploy our website.
Distinction:
GitHub (ex. https://github.com/cbw-dev/bookdown-template) holds your repo, which has version control for all your files!
The deployed website (ex. https://cbw-dev.github.io/bookdown-template/) has the workshop online.
How to Deploy Your Workshop Website
In the top navigation bar, select Settings.
Then, go to the Pages sidebar option.
“Deploy from a branch” is already selected, which is what we want. We must change the branch from “none” to “main”. Select the “None” dropdown button and select “main”.
Then, change the folder from
/ rootto/docs. Then press save.
Great! Now we’re waiting on the page to build and deploy, which should take less than a minute.
Check Your Deploy and See your Website!
To see updates, go to the Actions page (found along the top navigation bar. This will help you understand how the deploy is working, and if it succeeded or failed.
You can click pages build and deployment for updates.
A successful deploy will have a green checkmark next to it. You can inspect the 3 steps: build, report-build-status, deploy. Once it’s done deploying, you can find the website at the link provided under the “deploy” step!
A failed deploy will have a red cross next to it. Clicking through the steps can help you determine what went wrong in the deploy.
Warning: A website can build properly, but may not deploy properly! It is a good idea to check after making big changes.
