Skip to content

Commit

Permalink
Merge branch 'main' into remove-initial-batch-of-templates
Browse files Browse the repository at this point in the history
  • Loading branch information
frankieroberto committed Nov 25, 2024
2 parents 4ea0b82 + c0d5a59 commit a8a21ca
Show file tree
Hide file tree
Showing 50 changed files with 414 additions and 269 deletions.
7 changes: 6 additions & 1 deletion .gitpod.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,9 @@
# This configuration file was automatically generated by Gitpod.
# Please adjust to your needs (see https://www.gitpod.io/docs/introduction/learn-gitpod/gitpod-yaml)
# and commit this file to your remote git repository to share the goodness with others.

# Learn more from ready-to-use templates: https://www.gitpod.io/docs/introduction/getting-started/quickstart

tasks:
- init: npm install && npm run build
command: npm run watch
command: npm run start
4 changes: 2 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# Contribution guidelines

Thank you for your interest in contributing to NHS.UK prototype kit website, we really appreciate it. There are a number of ways that you can contribute – reporting bugs, fixing bugs, suggesting new features or writing documentation.
Thank you for your interest in contributing to NHS prototype kit website, we really appreciate it. There are a number of ways that you can contribute – reporting bugs, fixing bugs, suggesting new features or writing documentation.

This repository contains the documentation and guidance for the NHS.UK prototype kit. For the prototype kit itself, see [http://github.com/nhsuk/nhsuk-prototype-kit](http://github.com/nhsuk/nhsuk-prototype-kit) on GitHub.
This repository contains the documentation and guidance for the NHS prototype kit. For the prototype kit itself, see [http://github.com/nhsuk/nhsuk-prototype-kit](http://github.com/nhsuk/nhsuk-prototype-kit) on GitHub.

If you’re not sure whether an issue relates to the kit or the website for it, don’t worry, issues can be moved if needed.

Expand Down
26 changes: 20 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# NHS.UK prototype kit documentation
# NHS prototype kit documentation

This repository contains the content and code for the guidance website for the NHS.UK prototype kit.
This repository contains the content and code for the guidance website for the NHS prototype kit.

For the code for the NHS prototype kit itself, see [nhsuk-prototype-kit on GitHub](https://github.com/nhsuk/nhsuk-prototype-kit).

Expand All @@ -10,7 +10,7 @@ Start the code by running `npm run watch`.

## Contribute

If you want to contribute to the NHS.UK prototype kit guidance, then read our [contributing guidelines](CONTRIBUTING.md).
If you want to contribute to the NHS prototype kit guidance, then read our [contributing guidelines](CONTRIBUTING.md).

### Style guide

Expand All @@ -20,11 +20,25 @@ We normally use the [NHS content guide](https://service-manual.nhs.uk/content) f

Lower case. Only use for Windows instructions. Normally it will be ‘the command line’.

#### Git, git, Github

Git has an upper case G when talking about a version control system (for example 'use GitHub '), and lower case G when part of code, for example `git status`.

GitHub is camel case with an upper case H - for example, 'use GitHub Desktop'.


#### GOV.UK Prototype Kit, GOV.UK Design System and other GOV.UK products

Title case.

#### Headings and tab titles
Use sentence case, for example 'How to download the prototype kit'.
Tab titles (the title of the page as shown in the browser tab) may be different from the page H1, for example a tab title may say 'How to download the prototype kit' and the H1 say 'Download the prototype kit'.

#### JavaScript

Camel case with an upper case S.

#### NHS, NHS.UK, NHS England


Expand All @@ -44,11 +58,11 @@ Use ‘NHS England Windows laptops’ instructions for people using corporate la

#### NHS prototype kit

‘NHS’ is in caps and ‘prototype kit’ in lower case (except where it is shown next to the NHS logo when it is capitalised as ‘NHS Prototype kit’). Write out in full the first time it is used on a page, then call ’the kit’. Do not use ‘prototype kit’ if you can.
‘NHS’ is in caps and ‘prototype kit’ in lower case (except where it is shown next to the NHS logo when it is capitalised as ‘NHS Prototype kit’). Write out in full the first time it is used on a page, then call ’the kit’. Try to avoid ‘prototype kit’.

#### terminal

Lower case. Only use for Mac and Linux instructions. Usually it will be ‘the terminal’.
Lower case. Usually it will be ‘the terminal’.

#### Visual Studio Code

Expand All @@ -57,4 +71,4 @@ Title case. When you use it for the first time in a guide, start with 'Visual St

## Support

The NHS.UK prototype kit guidance website is maintained by NHS England. [Email us](<mailto:[[email protected]](mailto:[email protected])>), open a [Github issue](https://github.com/nhsuk/nhsuk.service-manual.prototype-kit.docs/issues/new) or get in touch on the [NHS digital service manual Slack workspace](https://join.slack.com/t/nhs-service-manual/shared_invite/enQtNTIyOTEyNjU3NDkyLTk4NDQ3YzkwYzk1Njk5YjAxYTI5YTVkZmUxMGQ0ZjA3NjMyM2ZkNjBlMWMxODVjZjYzNzg1ZmU4MWY1NmE2YzE).
The NHS prototype kit guidance website is maintained by NHS England. [Email us](<mailto:[[email protected]](mailto:[email protected])>), open a [Github issue](https://github.com/nhsuk/nhsuk.service-manual.prototype-kit.docs/issues/new) or get in touch on the [NHS digital service manual Slack workspace](https://join.slack.com/t/nhs-service-manual/shared_invite/enQtNTIyOTEyNjU3NDkyLTk4NDQ3YzkwYzk1Njk5YjAxYTI5YTVkZmUxMGQ0ZjA3NjMyM2ZkNjBlMWMxODVjZjYzNzg1ZmU4MWY1NmE2YzE).
18 changes: 9 additions & 9 deletions app/views/about.html
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{% extends 'layout.html' %}

{% block pageTitle %}
About - NHS.UK prototype kit
About - NHS prototype kit
{% endblock %}

{% block beforeContent %}
Expand All @@ -18,34 +18,34 @@

<h1>About</h1>

<p class="nhsuk-lede-text">The NHS.UK prototype kit enables you to make interactive prototypes that will look like NHS services and pages on NHS.UK. The prototypes you make are a great way to show ideas to others and for conducting user research.</p>
<p class="nhsuk-lede-text">The NHS prototype kit enables you to make interactive prototypes that look like NHS services, such as the NHS website (<a href="http://nhs.uk">www.nhs.uk</a>). The prototypes you make are a great way to show ideas to others and for conducting user research.</p>

<h2>Support</h2>

<p>The NHS.UK prototype kit is maintained by NHS England. If you've got a question or need support you can:</p>
<p>The NHS prototype kit is maintained by NHS England. If you've got a question or need support you can:</p>

<ul>
<li><a href="mailto:[email protected]?subject=NHS.UK prototype kit - About">email us</a></li>
<li><a href="mailto:[email protected]?subject=NHS prototype kit - About">email us</a></li>
<li><a href="https://nhs-service-manual.slack.com/messages/CFYL2GDGW" rel="nofollow">get in touch on the NHS digital service manual #prototype-kit Slack channel</a></li>
<li><a href="https://github.com/nhsuk/nhsuk-prototype-kit/issues">view known issues on GitHub</a></li>
</ul>

<h2>Contributing</h2>

<p>The prototype kit is always evolving as we learn more. Help us to improve and grow it:</p>
<p>The prototype kit is always evolving as we learn more. Help us to improve and grow it by:</p>

<ul>
<li><a href="https://nhs-service-manual.slack.com/messages/CFYL2GDGW" rel="nofollow">get in touch on the NHS digital service manual #prototype-kit Slack channel</a></li>
<li><a href="https://github.com/nhsuk/nhsuk-prototype-kit/issues">create a GitHub issue</a></li>
<li><a href="https://nhs-service-manual.slack.com/messages/CFYL2GDGW" rel="nofollow">getting in touch on the NHS digital service manual #prototype-kit Slack channel</a></li>
<li><a href="https://github.com/nhsuk/nhsuk-prototype-kit/issues/new/choose">reporting or creating a issue in GitHub</a></li>
</ul>

<h2>Privacy</h2>

<p>You must protect user privacy at all times, even when using prototypes. Prototypes made with the kit look like NHS.UK, but do not have the same security provisions. Always make sure you are handling user data appropriately.</p>
<p>You must protect user privacy at all times, even when using prototypes. Prototypes made with the kit look like NHS services, but do not have the same security provisions. Always make sure you are handling user data appropriately.</p>

<h2>The kit is not a production framework</h2>

<p>Things made with the kit may look like NHS.UK, but do not have production code and likely aren't fully accessible. Don't use the kit as a base for a production service.</p>
<p>Things made with the kit may look like NHS services, but do not have production code and likely are not fully accessible. Do not use the kit as a base for a production service.</p>

</div>

Expand Down
23 changes: 7 additions & 16 deletions app/views/cookies.html
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{% extends 'layout.html' %}

{% block pageTitle %}
Cookies - NHS.UK prototype kit
Cookies - NHS prototype kit
{% endblock %}

{% block beforeContent %}
Expand All @@ -16,29 +16,20 @@

<div class="nhsuk-grid-column-two-thirds">

<h1>Cookies on the NHS.UK prototype kit</h1>
<h1>Cookies on the NHS prototype kit</h1>

<p>
Cookies are small files saved on your phone, tablet or computer when you visit a website.
</p>
<p>Cookies are small files saved on your phone, tablet or computer when you visit a website.</p>

<p>
They store information about how you use the website. Some of them can be turned on and off.
</p>
<p>They store information about how you use the website. Some of them can be turned on and off.</p>

<p>
The NHS.UK prototype kit only stores cookies that are essential to make the site work properly.
This means they cannot be turned off.
</p>
<p>The NHS prototype kit only stores cookies that are essential to make the site work properly. This means they cannot be turned off.</p>

<p>
You can’t be identified by the cookies used on the NHS.UK prototype kit.
</p>
<p>You cannot be identified by the cookies used on the NHS prototype kit.</p>

<h2>Cookies needed for the website to work</h2>

<table class="nhsuk-table nhsuk-u-margin-top-0">
<caption class="nhsuk-table__caption">Cookies used on the NHS.UK prototype kit</caption>
<caption class="nhsuk-table__caption">Cookies used on the NHS prototype kit</caption>
<thead class="nhsuk-table__head">
<tr class="nhsuk-table__row">
<th class="nhsuk-table__header" scope="col">Name</th>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@ <h1>
},
{
"URL": "https://github.com/nhsuk/nhsuk-prototype-kit",
"label": "NHS.UK prototype kit - GitHub"
"label": "NHS prototype kit - GitHub"
}
]
})}}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ <h1 class="nhsuk-card__title nhsuk-u-margin-bottom-4">
},
{
"URL": "https://github.com/nhsuk/nhsuk-prototype-kit",
"label": "NHS.UK prototype kit - GitHub"
"label": "NHS prototype kit - GitHub"
}
]
})}}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ <h1 class="nhsuk-fieldset__heading">
<div class="nhsuk-checkboxes__item">
<input class="nhsuk-checkboxes__input" id="conditions-7" name="condition" type="checkbox" value="Heart Disease"{{ checked("condition", "Heart Disease") }}>
<label class="nhsuk-label nhsuk-checkboxes__label" for="conditions-7">
Heart Disease
Heart disease
</label>
</div>
<div class="nhsuk-checkboxes__item">
Expand Down Expand Up @@ -91,7 +91,7 @@ <h1 class="nhsuk-fieldset__heading">
},
{
"URL": "https://github.com/nhsuk/nhsuk-prototype-kit",
"label": "NHS.UK prototype kit - GitHub"
"label": "NHS prototype kit - GitHub"
}
]
})}}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@ <h1 class="nhsuk-fieldset__heading">
},
{
"URL": "https://github.com/nhsuk/nhsuk-prototype-kit",
"label": "NHS.UK prototype kit - GitHub"
"label": "NHS prototype kit - GitHub"
}
]
})}}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ <h1 class="nhsuk-fieldset__heading">
},
{
"URL": "https://github.com/nhsuk/nhsuk-prototype-kit",
"label": "NHS.UK prototype kit - GitHub"
"label": "NHS prototype kit - GitHub"
}
]
})}}
Expand Down
22 changes: 12 additions & 10 deletions app/views/how-tos/adding-assets.html
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{% extends 'layout.html' %}

{% block pageTitle %}
Adding CSS, JavaScript and Images - NHS.UK prototype kit
Adding CSS, JavaScript and images - NHS prototype kit
{% endblock %}

{% block beforeContent %}
Expand All @@ -14,14 +14,14 @@
<div class="nhsuk-grid-column-two-thirds">

<h1>
Adding CSS, JavaScript and Images
Adding CSS, JavaScript and images
</h1>

<p>The prototype kit comes with standard NHS.UK frontend styles and components for you to use in your prototypes. However if you need to add your own CSS (Cascading Style Sheets), JavaScript or images, use the <code class="app-code">/app/assets</code> folder.</p>
<p>The prototype kit comes with standard NHS.UK frontend styles and components for you to use in your prototypes. However, if you need to add your own CSS (cascading style sheets), JavaScript or images, use the <code class="app-code">/app/assets</code> folder.</p>

<p>The prototype kit processes all the files in the <code class="app-code">/app/assets</code> folder, and puts the processed files in <code class="app-code">/public</code>.</p>

<p>Do not change files in the <code class="app-code">/public</code> folder because its deleted and rebuilt every time you make a change to your prototype.</p>
<p>Do not change files in the <code class="app-code">/public</code> folder because it's deleted and rebuilt every time you make a change to your prototype.</p>

<h2 id="css">CSS</h2>

Expand All @@ -41,7 +41,7 @@ <h2 id="css">CSS</h2>
{{'{% endblock %}'}}</code></pre>


<p>Do not edit the file <code class="app-code">/public/styles/main.css</code> because its deleted and rebuilt every time you make a change to your prototype.</p>
<p>Do not edit the file <code class="app-code">/public/styles/main.css</code> because it's deleted and rebuilt every time you make a change to your prototype.</p>

<p>The prototype kit uses <a href="https://sass-lang.com/guide">Sass</a>, which adds extra features to CSS.</p>

Expand All @@ -53,11 +53,11 @@ <h3 id="using-import">Using import</h3>

<pre class="app-pre"><code class="app-code">@import "admin";</code></pre><h2 id="javascript">JavaScript</h2>

<p>You can use JavaScript to make changes to a web page without loading a new one. For example a user could enter some numbers, then JavaScript displays the results of a calculation without loading a new page.</p>
<p>You can use JavaScript to make changes to a web page without loading a new one. For example, a user could enter some numbers, then JavaScript displays the results of a calculation without loading a new page.</p>

<p>To add JavaScript use:</p>

<pre class="app-pre"><code class="app-code">/app/assets/javascripts/main.js</code></pre><p>Do not edit the file <code class="app-code">/public/javascript/main.js</code> because its deleted and rebuilt every time you make a change to your prototype.</p>
<pre class="app-pre"><code class="app-code">/app/assets/javascripts/main.js</code></pre><p>Do not edit the file <code class="app-code">/public/javascript/main.js</code> because it's deleted and rebuilt every time you make a change to your prototype.</p>

<h2 id="images">Images</h2>

Expand All @@ -69,9 +69,9 @@ <h2 id="images">Images</h2>

<p>Use it in your page like this:</p>

<pre class="app-pre"><code class="app-code">&lt;img src="/images/user.png" alt="User icon"&gt;</code></pre><p>Use alt text to describe the image for screen readers.</p>
<pre class="app-pre"><code class="app-code">&lt;img src="/images/user.png" alt="User icon"&gt;</code></pre><p>Use 'alt' text to describe the image for screen readers.</p>

<p>Do not put files directly in <code class="app-code">/public</code> because its deleted and rebuilt every time you make a change to your prototype.</p>
<p>Do not put files directly in <code class="app-code">/public</code> because it's deleted and rebuilt every time you make a change to your prototype.</p>

<h2 id="other-files">Other files</h2>

Expand All @@ -81,7 +81,9 @@ <h2 id="other-files">Other files</h2>

<pre class="app-pre"><code class="app-code">/app/assets/downloads/report.pdf</code></pre><p>Link to it like this:</p>

<pre class="app-pre"><code class="app-code">&lt;a href="/downloads/report.pdf"&gt;Download the report&lt;/a&gt;</code></pre><p>Do not put files directly in <code class="app-code">/public</code> because it’s deleted and rebuilt every time you make a change to your prototype.</p>
<pre class="app-pre"><code class="app-code">&lt;a href="/downloads/report.pdf"&gt;Download report (PDF only, 1MB)&lt;/a&gt;</code></pre><p>Do not put files directly in <code class="app-code">/public</code> because it's deleted and rebuilt every time you make a change to your prototype.</p>

<p>We avoid publishing PDFs, however. Read the guidance on <a href="https://service-manual.nhs.uk/content/pdfs-and-other-non-html-documents">PDFs and other non-HTML documents in the service manual</a>.</p>
</div>

</div>
Expand Down
2 changes: 1 addition & 1 deletion app/views/how-tos/branching.html
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{% extends "layout.html" %}

{% block pageTitle %}
Branching - NHS.UK prototype kit
How to do branching - NHS prototype kit
{% endblock %}

{% block beforeContent %}
Expand Down
2 changes: 1 addition & 1 deletion app/views/how-tos/build-basic-prototype/_BASE.njk
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
{% set exampleIneligible = { url: "ineligible" } %}

{% block pageTitle %}
{{ pageTitle | default("Add title with 'pageTitle'")}} - {{sectionName}} - NHS.UK prototype kit
{{ pageTitle | default("Add title with 'pageTitle'")}} - {{sectionName}} - NHS prototype kit
{% endblock %}

{% block beforeContent %}
Expand Down
Loading

0 comments on commit a8a21ca

Please sign in to comment.