Skip to content

Commit c7bce52

Browse files
Merge branch 'main' into hpv-self-sampling-first
2 parents 3739cdb + 92a21ac commit c7bce52

File tree

21 files changed

+458
-26
lines changed

21 files changed

+458
-26
lines changed

README.md

Lines changed: 19 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -7,56 +7,59 @@ A place for services within digital prevention services to document their design
77
1. Clone the repo to a folder on your computer
88
2. In your terminal, `cd` to the folder
99
3. Run `npm install` to install pre-requisites
10-
4. Run `npm run start` to build the design history site and serve it
10+
4. Run `npm start` to build the design history site and serve it
1111
5. View the site locally at `localhost:8080`
1212

1313
## Adding a new service
1414

1515
To add a new service, there is some set up involved.
1616

17-
You will need to create some files and folders based on the name of your service, using lowercase and hypens. For example `your-service-name`.
17+
You will need to create some files and folders based on the name of your service, using lowercase and hyphens. For example `your-service-name`.
1818

1919
You’ll need to:
2020

21-
* create a folder for your service within `app/posts/`, for example `app/posts/your-service-name/`
22-
* create a folder with the same name in `app/images/`, for example `app/images/your-service-name/`
23-
* create a `your-service-name.json` file within `app/posts/` that adds the eleventyNavigation parent name as the name of your service (copy an existing example)
24-
* create a Markdown file in `app/posts/`, for example `app/posts/your-service-name.md`. Copy an existing example and update any references to match your service.
25-
* update `eleventy.config.js` to create a new 'collection' for your service (copy one of the existing examples)
26-
* update `app/_layouts/_product.njk` to list your new service in the `sections` variable
21+
- create a Markdown file in `app/posts/`, for example `app/posts/your-service-name.md`. Copy an existing example and update any references to match your service.
22+
- create a folder for your service in `app/images/`, for example `app/images/your-service-name/`
23+
- create a folder for your service in `app/posts/`, for example `app/posts/your-service-name/`
24+
- inside your service’s post folder, create a JSON file `your-service-name.json`, for example `app/posts/your-service-name/your-service-name.json`. Copy an existing example for what to put in it.
25+
- update `eleventy.config.js` to create a new ‘collection’ for your service (copy one of the existing examples)
26+
- update `app/_layouts/_product.njk` to list your new service in the sections variable
27+
- open a pull request with your changes
2728

2829
See [Divide a design history into different sections](https://x-govuk.github.io/govuk-design-history/divide-a-design-history-into-sections/).
2930

3031
## Adding a new post
3132

3233
You have two choices for adding a post:
3334

34-
* [Add a post manually](#add-a-post-manually)
35-
* [Use the post generation scripts](https://x-govuk.github.io/govuk-design-history/generate-a-page-of-screenshots/)
35+
- [Add a post manually](#add-a-post-manually)
36+
- [Use the post generation scripts](https://x-govuk.github.io/govuk-design-history/generate-a-page-of-screenshots/)
3637

3738
### Add a post manually
3839

39-
1. Draft your design history post - it's often easiest to do this in Sharepoint
40-
1. Create a new markdown file in `app/posts/[service-name]/YYYY/MM/[post-name].md`
41-
* * It's often easier to duplicate an existing post as that will have the headers you need
40+
1. Draft your design history post - it’s often easiest to do this in SharePoint
41+
2. Create a new markdown file in `app/posts/[service-name]/YYYY/MM/[post-name].md`
42+
43+
> It’s often easier to duplicate an existing post as that will have the headers you need
44+
4245
3. Edit the post with your content - make sure it has a title, subtitle, and date
4346
4. If you have images, add them to a folder in `app/images/[service-name]/YYYY/MM/[post-name]/`
44-
5. Make a PR with your changes and get it reviewed
47+
5. Make a pull request with your changes and get it reviewed
4548

4649
### Add a post using the generation scripts
4750

4851
[View more details on the scripts here.](https://x-govuk.github.io/govuk-design-history/generate-a-page-of-screenshots/)
4952

5053
1. Use a PNG optimiser [like TinyPNG](https://tinypng.com/) to reduce the file size of your images.
5154
2. Create a folder for your images and put them in `app/images/[service-name]/YYYY/MM/[post-name]/`
52-
3. From the terminal, run `node scripts/generate.js [path]` where `path` is the full path to the folder of images. The easiest way to do this is to type `node scripts/generate.js ` and then drag the folder from Finder on to your terminal to fill in the path.
55+
3. From the terminal, run `node scripts/generate.js [path]` where `path` is the full path to the folder of images. The easiest way to do this is to type `node scripts/generate.js` and then drag the folder from Finder on to your terminal to fill in the path.
5356
4. The script will generate a new post linking to each image and place it in `app/posts/[service-name]/YYYY/MM/[post-name].md`.
5457
5. You should check the title text for each image and amend as needed.
5558
6. The script will prepend the post filename with the current date but you can delete this if you like.
5659

5760
## Deploying and publishing
5861

59-
Once you have a post you want to publish, make a PR on this repo with your suggested change.
62+
Once you have a post you want to publish, make a pull request on this repo with your suggested change.
6063

6164
Once it is merged the updated design history will automatically deploy with your post.
6265

app/_layouts/product.njk

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,8 +35,9 @@
3535
{ title: "Screening", services: [
3636
"Bowel screening",
3737
"Explore team",
38+
"HPV Self-Sampling",
3839
"Manage breast screening",
39-
"HPV Self-Sampling"
40+
"Manage your screening"
4041
] },
4142
{ title: "Vaccinations", services: [
4243
"Book a vaccination",

app/guide/how-to-add-a-new-service.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,10 +14,10 @@ You will need to create some files and folders based on the name of your service
1414

1515
You’ll need to:
1616

17-
* create a folder for your service within `app/posts/`, for example `app/posts/your-service-name/`
18-
* create a folder with the same name in `app/images/`, for example `app/images/your-service-name/`
19-
* create a `your-service-name.json` file within `app/posts/` that adds the eleventyNavigation parent name as the name of your service (copy an existing example)
2017
* create a Markdown file in `app/posts/`, for example `app/posts/your-service-name.md`. Copy an existing example and update any references to match your service.
18+
* create a folder for your service in `app/images/`, for example `app/images/your-service-name/`
19+
* create a folder for your service in `app/posts/`, for example `app/posts/your-service-name/`
20+
* inside your service’s post folder, ceate a json file `your-service-name.json`, for exampole `app/posts/your-service-name/your-service-name.json`. Copy an existing example for what to put in it.
2121
* update `eleventy.config.js` to create a new 'collection' for your service (copy one of the existing examples)
2222
* update `app/_layouts/_product.njk` to list your new service in the sections variable
2323
* open a pull request with your changes
159 KB
Loading
1.5 MB
Loading
71.1 KB
Loading
258 KB
Loading
242 KB
Loading
28.7 KB
Loading

app/posts/hpv-self-sampling/2025/03/2025-03-31-hpv-self-sampling-context.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ tags:
77
- hpv self sampling
88
- nhs ambitions
99
---
10+
1011
> The UKNSC is consulting on introducing self sampling for cervical screening. Find out more: [UK NSC consults on offering HPV self-sampling option to under-screened people in cervical screening programme – UK National Screening Committee.](https://nationalscreening.blog.gov.uk/2024/12/04/uk-nsc-consults-on-offering-hpv-self-sampling-option-to-under-screened-people-in-cervical-screening-programme/)
1112
**We are running discovery and alpha in parallel to this consultation, to prepare for potential implementation in future.**
1213

0 commit comments

Comments
 (0)