Skip to content

Commit 22bc830

Browse files
Update guide to adding a new service (#239)
This has changed and is a bit simpler now that you don’t have to create separate folders within `app/posts` and `app/images`.
1 parent 1def139 commit 22bc830

File tree

1 file changed

+4
-7
lines changed

1 file changed

+4
-7
lines changed

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

Lines changed: 4 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -8,16 +8,13 @@ eleventyNavigation:
88

99
Posts in this design history are grouped by the service or team they relate to. Before you can start publishing posts, you need to add your service. You only need to do this once.
1010

11-
You may want to [look at an existing pull request](https://github.com/NHSDigital/prevention-services-design-history/pull/20) to see the files you need to update.
12-
13-
You will need to create some files and folders based on the name of your service, using lowercase and hypens. For example, for `Manage breast screening` you would use `manage-breast-screening`.
11+
You will need to create some files and folders based on the name of your service, using lowercase and hyphens. For example, for `Manage breast screening` you would use `manage-breast-screening`.
1412

1513
You’ll need to:
1614

17-
- 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 example `app/posts/your-service-name/your-service-name.json`. Copy an existing example for what to put in it.
15+
- create a subfolder for the service within `app/`, for example `app/your-service-name/`.
16+
- inside your service’s subfolder, 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.
17+
- create a Markdown file in `app/` named after the service, for example `app/your-service-name.md`. Copy an existing example and update any references to match your service. The `area` value should be set to either `screening`, `vaccinations` or `personalised-prevention`.
2118
- update `eleventy.config.js` to add the name of the service, for example `"your-service-name"`, within the list of services under the `// Service collections` line.
2219
- **note:** you will need to [add a post](/guide/how-to-publish/) before the service can be found in the navigation.
2320
- open a pull request with your changes.

0 commit comments

Comments
 (0)