You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+24-17Lines changed: 24 additions & 17 deletions
Original file line number
Diff line number
Diff line change
@@ -12,31 +12,38 @@ This repo features:
12
12
13
13
## Contributing to this repo
14
14
15
-
* 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
16
-
* Create an issue for the thing you want to add on GitHub
17
-
* Clone the repository (in RStudio, File > New Project > Checkout a project from a version controlled repository). Paste in the URL of this repository
18
-
* Check out the main branch and check it's up to date in the RStudio Terminal (type `git checkout main && git pull` in terminal)
19
-
* Check out a new branch (`git checkout -b issue-number` in terminal)
15
+
1. 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. Alternatively, you can [fork the repository](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/fork-a-repo) to your own GitHub account.
16
+
2. Create an issue for the thing you want to add on GitHub
17
+
3. 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.
18
+
4. Check out the main branch and check it's up to date in the RStudio Terminal (type `git checkout main && git pull` in terminal)
19
+
5. Check out a new branch (`git checkout -b issue-number` in terminal)
20
20
21
-
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
21
+
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. 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.
22
22
23
23
### How to create a new presentation
24
24
25
-
* 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.
26
-
* Add a link to the presentation folder in the bulleted list in the `index.qmd` file in presentations:
27
-
*`* presentations/YYYY-MM-DD_Talk-title`
25
+
1. 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.
26
+
2. Add a link to the presentation folder in the bulleted list in the `index.qmd` file in presentations:
27
+
\n`* presentations/YYYY-MM-DD_Talk-title`
28
28
29
29
30
30
### How to create a new blogpost
31
31
32
-
* Navigate to the `blogs/posts` folder
33
-
* Copy a previous blogpost file and use that as your template
34
-
* 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.
32
+
1. Navigate to the `blogs/posts` folder
33
+
2. Copy a previous blogpost file and use that as your template
34
+
3. 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.
35
35
36
36
37
-
### Pushing your blog post/presentation to GitHub
37
+
### How to create/edit pages on the website
38
38
39
-
* Save your file, then add and commit it (`git add file.qmd` and `git commit -m "Add blog post/presentation about x"`)
40
-
* Push your content to your branch in GitHub (`git push origin branchname`).
41
-
* 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.
42
-
* When approved and merged to main, the Quarto page will automatically be rendered thanks to the GitHub action that has been set up.
39
+
1. Find the `.qmd` file that you wish to edit. For example, if you want to add to the Style Guide page, edit the `style/style_guide.qmd` file.
40
+
2. If creating a new page, copy an existing `.qmd` file and use that as a template.
41
+
3. 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.
42
+
43
+
44
+
### Pushing your blog post/presentation/page to GitHub
45
+
46
+
1. Save your file, then add and commit it (`git add file.qmd` and `git commit -m "Add blog post/presentation about x"`)
47
+
2. Push your content to your branch in GitHub (`git push origin branchname`).
48
+
3. 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.
49
+
4. When approved and merged to main, the Quarto page will automatically be rendered thanks to the GitHub action that has been set up.
0 commit comments