Skip to content

Commit 6a2cf4c

Browse files
authored
Merge pull request #96 from The-Strategy-Unit/88_93
Adds info on adding new page, contributing via forking, and fixes dark mode
2 parents 9e517fc + e073cb4 commit 6a2cf4c

File tree

2 files changed

+26
-17
lines changed

2 files changed

+26
-17
lines changed

README.md

Lines changed: 24 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -12,31 +12,38 @@ This repo features:
1212

1313
## Contributing to this repo
1414

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)
2020

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.
2222

2323
### How to create a new presentation
2424

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`
2828

2929

3030
### How to create a new blogpost
3131

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.
3535

3636

37-
### Pushing your blog post/presentation to GitHub
37+
### How to create/edit pages on the website
3838

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.

theme-dark.scss

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,5 +4,7 @@ $navbar-bg: #2c2825;
44
$navbar-fg: #f9bf07;
55

66
$body-bg: #2c2825;
7+
$code-block-bg: #000000;
78
$body-fg: #f5f4f3;
9+
$body-color: #f5f4f3;
810
$link-color: #5881c1;

0 commit comments

Comments
 (0)