Skip to content

Commit

Permalink
CCM-6061 + CCM-6075 Content changes (#50)
Browse files Browse the repository at this point in the history
* CCM-6061 + CCM-6075 Content changes

* Changed 'free-text templates' to 'free-text messages' on the landing page. Moved some pages into different subsections in 'Using NHS Notify'.

* CCM-6061 and CCM-6075 commit workaround - added content to unpublished page /using-nhs-notify/links-and-urls

---------

Co-authored-by: emmagifford <[email protected]>
  • Loading branch information
jakecosgrove and emmagifford authored Aug 12, 2024
1 parent 8132afa commit 41a3d5e
Show file tree
Hide file tree
Showing 19 changed files with 71 additions and 35 deletions.
4 changes: 2 additions & 2 deletions docs/_data/home/heading.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
heading: Send NHS App messages, emails, texts and letters to patients and the public
description: |
You can use NHS Notify if you work in NHS England and support direct care.
image: landing-main-image.svg
You can use NHS Notify if you work in or with NHS England to support patient care.
image: landing-main-image-2.svg
image_alt: |
A graphic representation of NHS Notify's message channels: NHS App, email, text message and letter.
10 changes: 5 additions & 5 deletions docs/_data/home/how-it-works.yml
Original file line number Diff line number Diff line change
@@ -1,22 +1,22 @@
- heading: Write your messages
description: |
Create and edit reusable templates for each message channel:
Create reusable templates or free-text messages for each message channel:
- NHS App messages and notifications
- emails
- text messages (SMS)
- letters
image: 1-write-your-message.svg
image_alt: A screenshot showing how you write messages using NHS Notify's user interface.

- heading: Choose your recipients
- heading: Tell us who to message using their NHS number
description: |
Provide the NHS numbers of the people you want to send messages to.
You only need a person’s NHS number to send them messages.
image: 2-choose-your-recipients.svg
image_alt: A screenshot of computer code showing how you choose your message recipients.
image_alt: A screenshot of computer code showing how you provide your recipients.

- heading: Plan how your messages will be sent
description: |
Set up routing plans to decide how your messages will be sent to your recipients.
Set up routing plans to decide how your messages will be sent to recipients.
image: 3-plan-your-messages.svg
image_alt: A graphic of a phone, laptop and letter (numbered 1, 2 and 3 in that order) to show that you can send messages with each message channel in a specific order.

Expand Down
41 changes: 41 additions & 0 deletions docs/assets/images/landing-main-image-2.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 0 additions & 2 deletions docs/pages/features/emails.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,4 @@ This page will tell you about our email layout and specification.
You might also want to understand more about:

- [email delivery times]({% link pages/using-nhs-notify/delivery-times.md %})
- [how to edit and format emails]({% link pages/using-nhs-notify/editing-and-formatting.md %})
- [adding links to emails]({% link pages/using-nhs-notify/links-and-urls.md %})
- [how to tell recipients who your emails are from]({% link pages/using-nhs-notify/tell-recipients-who-your-messages-are-from.md %})
4 changes: 1 addition & 3 deletions docs/pages/features/features.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,9 +26,7 @@ Create reusable templates for the message channels you want to use.

Once you’ve created a template you can:

- [edit and format your messages]({% link pages/using-nhs-notify/editing-and-formatting.md %})
- [add personalisation]({% link pages/using-nhs-notify/personalisation.md %})
- [include links and URLs]({% link pages/using-nhs-notify/links-and-urls.md %})
- [tell recipients who your messages are from]({% link pages/using-nhs-notify/tell-recipients-who-your-messages-are-from.md %})

## Plan how your messages will be sent
Expand Down Expand Up @@ -67,7 +65,7 @@ Track how many messages you’ve sent and find out which ones are not being deli

To send messages automatically, you’ll need a developer to integrate with the NHS Notify API.

[Read our API documentation (opens in a new tab)](https://digital.nhs.uk/developer/api-catalogue/nhs-notify){:target="_blank"}.
[Read our API documentation (opens in a new tab)](https://digital.nhs.uk/developer/api-catalogue/nhs-notify){:target="\_blank"}.

## Keep your data secure

Expand Down
1 change: 0 additions & 1 deletion docs/pages/features/letters.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,6 @@ You might want to understand more about:
- [letter pricing]({% link pages/pricing/letters.md %})
- [delivery times for letters]({% link pages/using-nhs-notify/delivery-times.md %})
- [return addresses]({% link pages/using-nhs-notify/tell-recipients-who-your-messages-are-from.md %})
- [how to edit and format letters]({% link pages/using-nhs-notify/editing-and-formatting.md %})
- [sending letters to people with access needs]({% link pages/using-nhs-notify/accessible-formats.md %})
- [sending letters to people who speak other languages]({% link pages/using-nhs-notify/letters-in-other-languages.md %})

Expand Down
1 change: 0 additions & 1 deletion docs/pages/features/nhs-app-messages.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,6 @@ You might also want to understand more about:

- [delivery times for NHS App messages]({% link pages/using-nhs-notify/delivery-times.md %})
- [how to tell recipients who your NHS App messages are from]({% link pages/using-nhs-notify/tell-recipients-who-your-messages-are-from.md %})
- [how to edit and format NHS App messages]({% link pages/using-nhs-notify/editing-and-formatting.md %})

## Push notifications

Expand Down
2 changes: 1 addition & 1 deletion docs/pages/using-nhs-notify/accessible-formats.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
layout: page
title: Accessible formats
parent: Using NHS Notify
nav_order: 5
nav_order: 1
permalink: /using-nhs-notify/accessible-formats
section: Writing a message
---
Expand Down
4 changes: 2 additions & 2 deletions docs/pages/using-nhs-notify/delivery-times.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@
layout: page
title: Delivery times
parent: Using NHS Notify
nav_order: 7
nav_order: 2
permalink: /using-nhs-notify/delivery-times
section: Writing a message
section: Sending a message
---

It can take different amounts of time for messages to be delivered depending on the message channel.
Expand Down
1 change: 1 addition & 0 deletions docs/pages/using-nhs-notify/editing-and-formatting.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ parent: Using NHS Notify
nav_order: 1
permalink: /using-nhs-notify/editing-and-formatting
section: Writing a message
published: false
---

NHS Notify uses Markdown to format content for emails and letters.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@
layout: page
title: Finding recipients with access or language needs
parent: Using NHS Notify
nav_order: 11
nav_order: 5
permalink: /using-nhs-notify/find-recipients-with-access-or-language-needs
section: Writing a message
section: Sending a message
---

NHS Notify identifies people who need messages in accessible formats or other languages (sometimes called preferences).
Expand Down
Binary file removed docs/pages/using-nhs-notify/image.png
Binary file not shown.
2 changes: 1 addition & 1 deletion docs/pages/using-nhs-notify/letters-in-other-languages.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
layout: page
title: Letters in other languages
parent: Using NHS Notify
nav_order: 6
nav_order: 2
permalink: /using-nhs-notify/letters-in-other-languages
section: Writing a message
---
Expand Down
3 changes: 3 additions & 0 deletions docs/pages/using-nhs-notify/links-and-urls.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ parent: Using NHS Notify
nav_order: 2
permalink: /using-nhs-notify/links-and-urls
section: Writing a message
published: false
---

When composing a message, write URLs in full. For example:
Expand Down Expand Up @@ -57,3 +58,5 @@ To see message formatting instructions while you’re editing an email template:
1. Go to the Templates page.
2. Create a new email template or choose an existing email template and select Edit.
3. The formatting guide with the available Markdown is on the right-hand side of the page.

CCM-6061 and CCM-6075 commit workaround.
4 changes: 2 additions & 2 deletions docs/pages/using-nhs-notify/providing-nhs-numbers.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@
layout: page
title: Providing NHS numbers
parent: Using NHS Notify
nav_order: 8
nav_order: 3
permalink: /using-nhs-notify/providing-nhs-numbers
section: Writing a message
section: Sending a message
---

You only need a patient's [NHS number](https://digital.nhs.uk/services/personal-demographics-service/nhs-number) to send them messages.
Expand Down
4 changes: 2 additions & 2 deletions docs/pages/using-nhs-notify/recipients-you-cannot-message.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@
layout: page
title: Recipients you cannot message
parent: Using NHS Notify
nav_order: 10
nav_order: 6
permalink: /using-nhs-notify/recipients-you-cannot-message
section: Writing a message
section: Sending a message
---

NHS Notify automatically prevents you from sending messages to people who you should not contact. This includes recipients with certain information on their records.
Expand Down
5 changes: 2 additions & 3 deletions docs/pages/using-nhs-notify/routing-plans.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,9 @@
layout: page
title: Routing plans
parent: Using NHS Notify
nav_order: 9
nav_order: 4
permalink: /using-nhs-notify/routing-plans
section: Writing a message

section: Sending a message
---

You'll need to create a routing plan to decide how messages will be sent to your recipients.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@
layout: page
title: Tell recipients who your messages are from
parent: Using NHS Notify
nav_order: 4
nav_order: 1
permalink: /using-nhs-notify/tell-recipients-who-your-messages-are-from
section: Writing a message
section: Sending a message
---

It’s important that your recipients know and trust who has sent them a message.
Expand Down
10 changes: 4 additions & 6 deletions docs/pages/using-nhs-notify/using-nhs-notify.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,17 +18,15 @@ This guidance is to help teams understand how to use NHS Notify.

## Writing a message

- [Editing and formatting]({% link pages/using-nhs-notify/editing-and-formatting.md %})
- [Links and URLs]({% link pages/using-nhs-notify/links-and-urls.md %})
- [Personalisation]({% link pages/using-nhs-notify/personalisation.md %})
- [Sender IDs]({% link pages/using-nhs-notify/tell-recipients-who-your-messages-are-from.md %})
- [Tell recipients who your messages are from]({% link pages/using-nhs-notify/tell-recipients-who-your-messages-are-from.md %})

## Sending a message

- [Delivery times]({% link pages/using-nhs-notify/delivery-times.md %})
- [Accessible formats]({% link pages/using-nhs-notify/accessible-formats.md %})
- [Letters in other languages]({% link pages/using-nhs-notify/letters-in-other-languages.md %})
- [Providing NHS Numbers]({% link pages/using-nhs-notify/providing-nhs-numbers.md %})
- [Routing plans]({% link pages/using-nhs-notify/routing-plans.md %})
- [Recipients you cannot message]({% link pages/using-nhs-notify/recipients-you-cannot-message.md %})
- [Accessible formats]({% link pages/using-nhs-notify/accessible-formats.md %})
- [Letters in other languages]({% link pages/using-nhs-notify/letters-in-other-languages.md %})
- [Find recipients with access or language needs]({% link pages/using-nhs-notify/find-recipients-with-access-or-language-needs.md %})
- [Recipients you cannot message]({% link pages/using-nhs-notify/recipients-you-cannot-message.md %})

0 comments on commit 41a3d5e

Please sign in to comment.