Skip to content

Commit 378a0b9

Browse files
Add guide for adding a new service (#89)
* Add guide for adding a new service
1 parent 4008a1e commit 378a0b9

File tree

1 file changed

+23
-0
lines changed

1 file changed

+23
-0
lines changed
Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
---
2+
layout: page
3+
title: How to add a new service
4+
description: A guide for our teams on how to add their service or team to the design history
5+
eleventyNavigation:
6+
parent: Guide
7+
---
8+
9+
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.
10+
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`
14+
15+
You’ll need to:
16+
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)
20+
* 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.
21+
* update `eleventy.config.js` to create a new 'collection' for your service (copy one of the existing examples)
22+
* update `app/_layouts/_product.njk` to list your new service in the sections variable
23+
* open a pull request with your changes

0 commit comments

Comments
 (0)