14 Link to homepage
Note
You can find more info on the Github homepage setup in Appendix B.
For the best experience, we strongly recommend setting up the local validation system described here.
14.1 Get your code
Use the below widget to generate your metadata entries for the website.
Metadata generator
14.2 Add to GitHub homepage
Navigate to your
bioinformaticsdotca.github.iorepo in yourCBWGithubfolder.Run
git pull. You can do this in Terminal/PowerShell, or if you prefer, you can use an integrated Git system in your code editor.Open the
img/folder and look to see if your workshop icon is present.
- If it is, make note of the filename.
- If not, add your icon to that folder. The naming convention is CODE_icon.[extension] (e.g. INR_icon.png, GPO_icon.jpg)
- Open the
workshops.jsonfile and paste the first output from the widget below the first square bracket.
14.3 Add to GitHub sitemap
- Open the
sitemap.xmlfile and paste the second output below the ``<urlset …>``` line at the top.
14.4 Update the website
Git add, commit, and push the file. Code for use on the command line is below.
git add workshops.json sitemap.xml git commit -m "YOUR MESSAGE HERE" git pushWhy don’t I need to run a Build step like I did for my Bookdown workshop website?
The logistics pages and homepage use a different site generator than your workshop pages do. For updates to appear on the logistics and home pages, all you need to do is save your changes and push them to GitHub. The sites will automatically update.
Go to the actions page and confirm that your update deploys successfully. This page has built-in validation: if your data does not match the expected format, deployment will fail.
Why is the homepage displaying a picture of a laptop instead of my workshop icon?
This is a generic 404 image - the website cannot find your icon. Double-check the filename and filepath in the
workshops.jsonfile, and double-check that your icon is named correctly.