Skip to content

Message, channel and supplier status content#83

Closed
jakecosgrove wants to merge 93 commits intomainfrom
message-channel-supplier-status-content
Closed

Message, channel and supplier status content#83
jakecosgrove wants to merge 93 commits intomainfrom
message-channel-supplier-status-content

Conversation

@jakecosgrove
Copy link
Contributor

Description

This PR is part of an update to all public facing content on message, channel and supplier statuses.

Main changes:

  • page title and slug changed to 'Message, channel and supplier status'
  • content changes throughout to better explain the relationship between each status
  • tables updated to reflect channel and supplier status separation
  • diagrams added to explain how the supplier statuses map to channel statuses

Context

Integrators have struggled to understand the relationships between message, channel and supplier status. This is slowing down the rate in which integrators onboard as they struggle to make important decisions about the statuses they want to receive by using NHS Notify API's callbacks.

It's important for our users to understand what message statuses mean and which ones they can receive so they can fully understand how each message they send performs.

Type of changes

  • Refactoring (non-breaking change)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would change existing functionality)
  • Bug fix (non-breaking change which fixes an issue)

Checklist

  • I am familiar with the contributing guidelines
  • I have followed the code style of the project
  • I have added tests to cover my changes
  • I have updated the documentation accordingly
  • This PR is a result of pair or mob programming

Sensitive Information Declaration

To ensure the utmost confidentiality and protect your and others privacy, we kindly ask you to NOT including PII (Personal Identifiable Information) / PID (Personal Identifiable Data) or any other sensitive data in this PR (Pull Request) and the codebase changes. We will remove any PR that do contain any sensitive information. We really appreciate your cooperation in this matter.

  • I confirm that neither PII/PID nor sensitive data are included in this PR and the codebase changes.

mark-r-bjss and others added 30 commits October 10, 2024 15:56
CCM-5869: Create accessibility statement page (NHSDigital#58)
Added mention of 'message cascades' in routing plan content for 'para…
- changes to /using-nhs-notify/mesh to match MESH guidance
- sender IDs changed to sender names
Message and channel status page + other edits
…mplates, /using-nhs-notify/text-message-templates and /using-nhs-notify/letter-templates.

These are based on the Confluence pages https://nhsd-confluence.digital.nhs.uk/pages/viewpage.action?spaceKey=RIS&title=3.8+Creating+letter+templates onwards, with some minor tweaks to word ordering. Romy has approved this content now.

Uploaded the standardised Word doc templates for all 4 channels to /assets/worddocs, and linked to these. Craig in cyber security approved this approach (see ticket for screenshot).

Updated /using-nhs-notify/personalisation in line with the Confluence page. The FAQs from onboarding indicated there's a user need to provide the PDS personalisation fields.

I also added content on how users provide their own personalisation data, in line with Tan's Confluence page https://nhsd-confluence.digital.nhs.uk/display/RIS/NHS+Notify+%7C+Personalisation+Fields.

In /pricing/text-messages, I replaced 'it will count as more than one message' with 'it will be charged as more than one message'. This was prompted by a comment from Romy on the text message template content. I tweaked the content to match the later version of the UI prototype, which we based on findings from user research.
…lisation-update

Creating templates guidance + personalisation updates + text message pricing update
Removed mention of bank holidays from emails and text message delivery times
… templates.

Updated link text for the 4 template pages in the Using NHS Notify parent page - removed 'Creating...' from the start of each link.
…l lower case. Updated downloadable links to follow the approach Jake researched, for example [letter template]({% link assets/worddocs/letter-template-nhs-notify.docx %})
Ignoring the 'English usage commit check' as it's not consistent to the GOV.UK / NHS style guide. 'URL' is to be written in full capitals.
Includes:
- Noto
- URL
- ctrl
- pending_enrichment
- unnotified
- permanent_failure
- temporary_failure
- technical_failure
- precompiled
- validation_failed
- fullName
- namePrefix
- clientRef
…nce your letter has been sent, it can take...' with 'Once you've provided us with recipients' NHS numbers, it can take up to 2 working days for our suppliers to dispatch your letter'.

I also added anchor links to the top of the same page, /using-nhs-notify/delivery-times, to make navigation easier.
Letter delivery times update + anchor links
PDS override content + page name tidy-up
… from the bulleted list of personalisation fields from PDS as these are for internal use only.

Restructured the first paragraph under ### Personal Demographics Service (PDS) personalisation fields. This was based off a conversation with Jake and it aims to clarify the link between PDS, NHS numbers and personalisation fields.
…ded the line 'flex-wrap: wrap;' in the following code:

.nhsuk-header__navigation-list {
  justify-content: flex-start;
  flex-wrap: wrap;
}

This is an interim step to make the main nav list items wrap correctly when the site is viewed on a mobile device. It's not our ultimate solution but it makes the site more mobile responsive and accessible.
PDS personalisation fields updates + main nav wrapping
…ions. Removed date of birth as as an example of a column header in a MESH request.
jakecosgrove and others added 28 commits January 10, 2025 10:08
- add and change link to sandbox environments
- Change 'lead in line' for details component in step 9
- replace(s) from device(s)
- rephrase bullets in step 9 'Prove you have developed your integration securely' to statements instead of questions
Add 'Onboard with NHS Notify' page
The migration of this page from the service catalogue has paused until changes to the onboarding process are confirmed and accurately reflected in the content.
Pause 'Onboard with NHS Notify' page migration
- Moved 'text message sender name' to last section of page to reflect preferred channel order of NHS Notify
- removed 'return addresses for letters heading'
- reordered bulleted list of anchor links to reflect heading structure
…also:

- added sentence about no spaces in placeholder text following Mike Houston's comment saying that
we need to be more restrictive as we're generalising across multiple suppliers and template systems
- added anchor links at top of page to help with navigation between the 2 types of personalisation and avoid the custom fields section being missed
…new section 'Converting your letter to a PDF' and updated 'Downloading Noto Sans' with language variant guidance. Added anchor links at the start to highlight the ordered steps users need to go through, including the new PDF conversion step.

Changed the personalisation sections in each of the 4 template pages in /using-nhs-notify. Simplified the content and linked to /using-nhs-notify/personalisation to reduce duplication and have one single source of truth.
…der' to be more consistent with the rest of the content.
…-Sans-font-updates

PDF conversion + Noto Sans language variant guidance CCM-8312 + typo fixes
Rossbugginsnhs/2025 01 06/fix upload version to v4 (NHSDigital#82)
@jakecosgrove jakecosgrove requested a review from a team as a code owner February 18, 2025 08:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants