Skip to content

Commit 67aeecd

Browse files
Update README (#456)
@veroje pointed out in #448 that the README was out-of-date (as we'd since changed the folder structure). There were some other things in it still out of date, so I did a quick review. Given that we now have guides on how to publish posts at https://design-history.prevention-services.nhs.uk/guide/ I thought we could link to those, rather than duplicate them in the README and have to maintain both? However those are being updated (@ralph-hawkins and @selina-dxw did [a review of them](https://nhs.sharepoint.com/:w:/r/sites/X26_Digital_Prevention_Service/Shared%20Documents/DPSP%20Personalised%20Prevention%20Services/09.%20Lung%20cancer%20risk%20check/Design/Design%20histories/Publishing%20a%20design%20history%20post.docx?d=wf1f8409f2163497491012dce7f96baae&csf=1&web=1&e=2cKfLA) so we might want to wait for those changes to be made before merging this.
1 parent 4a2a706 commit 67aeecd

1 file changed

Lines changed: 14 additions & 48 deletions

File tree

README.md

Lines changed: 14 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -2,58 +2,26 @@
22

33
A place for services within digital prevention services to document their design decisions and research learnings.
44

5-
## Installation and getting started
5+
## Contributing
66

7-
1. Clone the repo to a folder on your computer
8-
2. In your terminal, `cd` to the folder
9-
3. Run `npm install` to install pre-requisites
10-
4. Run `npm start` to build the design history site and serve it
11-
5. View the site locally at `localhost:8080`
7+
See [the guide](https://design-history.prevention-services.nhs.uk/guide/) for details on how to contribute.
128

13-
## Adding a new service
9+
There are posts on:
1410

15-
To add a new service, there is some set up involved.
11+
* [why we write design histories](https://design-history.prevention-services.nhs.uk/guide/why-we-write-design-histories/)
12+
* [what to include in a design history](https://design-history.prevention-services.nhs.uk/guide/what-to-include-in-a-design-history/)
13+
* [how to publish a design history entry](https://design-history.prevention-services.nhs.uk/guide/how-to-publish/)
1614

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`.
15+
There is also a [sample post template](https://design-history.prevention-services.nhs.uk/guide/a-sample-template/) and a [guide to using Markdown](https://design-history.prevention-services.nhs.uk/guide/using-markdown/).
1816

19-
You’ll need to:
17+
If you need to add a new service, follow [how to add a new service](https://design-history.prevention-services.nhs.uk/guide/how-to-add-a-new-service/).
2018

21-
- create a Markdown file in `app/`, for example `app/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/`, for example `app/your-service-name/`
23-
- inside your service’s post folder, create a JSON file `your-service-name.json`, for example `app/your-service-name/your-service-name.json`. Copy an existing example for what to put in it.
24-
- update `eleventy.config.js` to create a new ‘collection’ for your service (copy one of the existing examples)
25-
- open a pull request with your changes
19+
## Running the site locally
2620

27-
See [Divide a design history into different sections](https://x-govuk.github.io/govuk-design-history/divide-a-design-history-into-sections/).
21+
You don’t have to do this to contribute, you can use GitHub or Codespaces, but if you want to you can.
2822

29-
## Adding a new post
30-
31-
You have two choices for adding a post:
32-
33-
- [Add a post manually](#add-a-post-manually)
34-
- [Use the post generation scripts](https://x-govuk.github.io/govuk-design-history/generate-a-page-of-screenshots/)
35-
36-
### Add a post manually
37-
38-
1. Draft your design history post - it’s often easiest to do this in SharePoint
39-
2. Create a new markdown file in `app/[service-name]/YYYY/MM/[post-name]/index.md`
40-
41-
> It’s often easier to duplicate an existing post as that will have the headers you need
42-
43-
3. Edit the post with your content - make sure it has a title, subtitle, and date
44-
4. If you have images, add them to a folder in `app/images/[service-name]/YYYY/MM/[post-name]/`
45-
5. Make a pull request with your changes and get it reviewed
46-
47-
### Add a post using the generation scripts
48-
49-
[View more details on the scripts here.](https://x-govuk.github.io/govuk-design-history/generate-a-page-of-screenshots/)
50-
51-
1. Use a PNG optimiser [like TinyPNG](https://tinypng.com/) to reduce the file size of your images.
52-
2. Create a folder for your images and put them in `app/images/[service-name]/YYYY/MM/[post-name]/`
53-
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.
54-
4. The script will generate a new post linking to each image and place it in `app/[service-name]/YYYY/MM/[post-name].md`.
55-
5. You should check the title text for each image and amend as needed.
56-
6. The script will prepend the post filename with the current date but you can delete this if you like.
23+
1. Run `npm install` to install pre-requisites
24+
2. Run `npm start` to build the design history site and serve it
5725

5826
## Deploying and publishing
5927

@@ -65,10 +33,8 @@ Once it is merged the updated design history will automatically deploy with your
6533

6634
For issues relating to the NHS Digital prevention services design history, contact [Ed Horsford](https://github.com/edwardhorsford), [Frankie Roberto](https://github.com/frankieroberto) or [Ralph Hawkins](https://github.com/ralph-hawkins).
6735

68-
The [GOV.UK design history project](https://x-govuk.github.io/govuk-design-history/) is maintained by a small number of volunteers working across government.
69-
70-
For questions about using a design history for your service, bug reports or feedback, [submit a new issue](https://github.com/x-govuk/govuk-design-history-template/issues/new).
36+
For bug reports, feedback or suggestions you can [submit a new issue](https://github.com/NHSDigital/prevention-services-design-history/issues/new).
7137

7238
## Technical notes
7339

74-
The design history uses the [GOV.UK Design System](https://design-system.service.gov.uk) and the [Eleventy](https://www.11ty.dev) static site generator with the [GOV.UK Eleventy Plugin](https://x-govuk.github.io/govuk-eleventy-plugin/).
40+
The design history uses the [NHS Design System](https://service-manual.nhs.uk/design-system) and the [Eleventy](https://www.11ty.dev) static site generator with the [NHS.UK Eleventy Plugin](https://nhsuk-eleventy-plugin.x-govuk.org/).

0 commit comments

Comments
 (0)