If you have any questions or need help, please contact anyone from the Data Science team.
This repo features:
- Presentations the team have delivered
- A website/ blog that the data science team can use to blog and compile other forms of resources
- Guidance on good coding practices, also known as a "style guide"
- Request access from a member of the Data Science team, they need to add you as a contributor. Alternatively, you can fork the repository to your own GitHub account.
- Create an issue for the thing you want to add on GitHub
- Clone the repository (in RStudio, File > New Project > Checkout a project from a version controlled repository). Paste in the URL of this repository, or the forked repository if you have forked it.
- Check out the main branch and check it's up to date in the RStudio Terminal (type
git checkout main && git pull
in terminal) - Check out a new branch (
git checkout -b issue-number
in terminal)
Please note this project uses {renv}. On Windows, I needed to install the R toolchain RTools to compile some of the packages. If you have {renv} installed, run renv::install()
in your Console to install all the packages required by this project to render the Quarto webpage.
- Make the presentation with quarto, and put it in
presentations/
in aYYYY-MM-DD_Talk-title
folder. Your presentation should conform to the SU branding. - Add a link to the presentation folder in the bulleted list in the
index.qmd
file in presentations: \n* presentations/YYYY-MM-DD_Talk-title
- Navigate to the
blogs/posts
folder - Copy a previous blogpost file and use that as your template
- If you want to see how it looks before pushing to GitHub, click Render in RStudio. The HTML version of your new post should open in your browser.
- Find the
.qmd
file that you wish to edit. For example, if you want to add to the Style Guide page, edit thestyle/style_guide.qmd
file. - If creating a new page, copy an existing
.qmd
file and use that as a template. - If you want to see how it looks before pushing to GitHub, click Render in RStudio. The HTML version of your new post should open in your browser.
- Save your file, then add and commit it (
git add file.qmd
andgit commit -m "Add blog post/presentation about x"
) - Push your content to your branch in GitHub (
git push origin branchname
). - Then, on GitHub, make a pull request to main. Put any member of the Data Science team down as a reviewer. Link your pull request with your issue by typing
Closes #issuenumber
in the comment field of your pull request. - When approved and merged to main, the Quarto page will automatically be rendered thanks to the GitHub action that has been set up.