Merge pull request #90 from The-Strategy-Unit/88_blogpost_instructions

added instructions on adding new blogpost

README.md

@@ -1,22 +1,42 @@
 ## Data science team repo
 
+If you have any questions or need help, please contact anyone from [the Data Science team](https://the-strategy-unit.github.io/data_science/about.html).
+
 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"
+
+
 
-We expect it to feature:
-* A Quarto presentation theme that conforms to SU branding
+## Contributing to this repo
 
-We may end up splitting off some of these elements to make them easier to deploy, we haven't quite thought it through yet. If stuff does move around we'll update the README
+* Request access from a member of [the Data Science team](https://the-strategy-unit.github.io/data_science/about.html), they need to add you as a contributor
+* 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
+* 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)
 
-## How to create a new presentation
+Please note this project uses renv. On Windows, I needed to install the R toolchain [RTools](https://cran.r-project.org/bin/windows/Rtools/) to compile some of the packages
+
+### How to create a new presentation
 
-* Make a branch
-* Make the presentation with quarto, and put it in `presentations/` in a `YYYY-MM-DD_Talk-title` folder
+* Make the presentation with quarto, and put it in `presentations/` in a `YYYY-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:
   * `* presentations/YYYY-MM-DD_Talk-title`
- * Make a pull request to main
- * The Quarto will be rendered by a GitHub action to [the presentation section of the website](https://the-strategy-unit.github.io/data_science/presentations/)
 
-Please note this project uses renv. On Windows, I needed to install the R toolchain [RTools](https://cran.r-project.org/bin/windows/Rtools/) to compile some of the packages
+
+### How to create a new blogpost 
+
+* 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.
+
+
+### Pushing your blog post/presentation to GitHub
+
+* Save your file, then add and commit it (`git add file.qmd` and `git 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.