Skip to content

Make readme clearer #132

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
edwardhorsford merged 1 commit into from
Jun 3, 2025
Merged

Make readme clearer #132

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 7 additions & 6 deletions app/guide/how-to-add-a-new-service.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,14 +10,15 @@ Posts in this design history are grouped by the service or team they relate to.

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.

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

You’ll need to:

* 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.
* create a folder for your service in `app/images/`, for example `app/images/your-service-name/`
* create a folder for your service in `app/posts/`, for example `app/posts/your-service-name/`
* create a folder for your service in `app/images/`, for example `app/images/your-service-name/`.
* create a folder for your service in `app/posts/`, for example `app/posts/your-service-name/`.
* 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.
* update `eleventy.config.js` to create a new 'collection' for your service (copy one of the existing examples)
* update `app/_layouts/_product.njk` to list your new service in the sections variable
* open a pull request with your changes
* update `eleventy.config.js` to create a new 'collection' for your service (copy one of the existing examples).
* update `app/_layouts/_product.njk` to list your new service in the sections variable.
* **note:** you will need to [add a post](/guide/how-to-publish/) before the service can be found in the navigation.
* open a pull request with your changes.