Team blog

Welcome to the blog! Feel free to reuse the content which is all published with a CC0 licence. If you spot a mistake we'd be very happy to receive a PR ☺️

For the benefit of team members, a refresher on how to add a blog post.

• Clone the repo (if you have author rights to the repo, otherwise fork to your own GitHub)
• Check out the main branch and check it's up to date in the RStudio Terminal
  • type git checkout main && git pull
• Check out a new branch
  • git checkout -b name-of-branch
• Install nottshcMethods to get the {distill} post template
  • remotes::install_github("CDU-data-science-team/nottshcMethods")
• In RStudio run select File -> R markdown ... -> From Template.
• In the RStudio Menus select File -> R markdown ... -> From Template.
  • Naming convention for the post files is yyyy-mm-dd-name-of-blog
• Fill in the YAML at the top
  • Overwrite some of the automatically generated text like author and date
  • Think about what Categories the blog can be connected with, and there can be more than one in the YAML

  categories:
    - Packages
    - Security

• Write the post 🙂
• Save an image from the British Library collection into the same _post/ folder as the post, preferably in a new folder called img to keep it tidy and download the picture as Small to keep the size minimal.
  • Make sure that the post has the following code in the YAML:

  preview: img/name_of_image.jpg

Knitting and building

• Click "knit" whenever you want to preview how the post looks
• When you are finished knit the post for a final time and check it to make sure you are happy with it
• Don't forget! Build the website by going to the Build tab at the top right of RStudio (along with Environment/History/Connections...), then `Build Website

Version control`

• In the Terminal add all the files to git git add .
• Git commit git commit -m "Commit message"
• Git push git push
• Make a pull request to main on GitHub