Skip to content

Commit 7c2be4b

Browse files
Fix typos in README
1 parent e9d69e3 commit 7c2be4b

File tree

1 file changed

+19
-17
lines changed

1 file changed

+19
-17
lines changed

README.md

Lines changed: 19 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -7,57 +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 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, 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.
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
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
2828

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

3131
## Adding a new post
3232

3333
You have two choices for adding a post:
3434

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/)
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/)
3737

3838
### Add a post manually
3939

40-
1. Draft your design history post - it's often easiest to do this in Sharepoint
41-
1. Create a new markdown file in `app/posts/[service-name]/YYYY/MM/[post-name].md`
42-
* * 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+
4345
3. Edit the post with your content - make sure it has a title, subtitle, and date
4446
4. If you have images, add them to a folder in `app/images/[service-name]/YYYY/MM/[post-name]/`
45-
5. Make a PR with your changes and get it reviewed
47+
5. Make a pull request with your changes and get it reviewed
4648

4749
### Add a post using the generation scripts
4850

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

5153
1. Use a PNG optimiser [like TinyPNG](https://tinypng.com/) to reduce the file size of your images.
5254
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.
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.
5456
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`.
5557
5. You should check the title text for each image and amend as needed.
5658
6. The script will prepend the post filename with the current date but you can delete this if you like.
5759

5860
## Deploying and publishing
5961

60-
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.
6163

6264
Once it is merged the updated design history will automatically deploy with your post.
6365

0 commit comments

Comments
 (0)