From 0066be7d5a25bc443e3bec22269a61113bf6149f Mon Sep 17 00:00:00 2001 From: Owen Jones Date: Mon, 4 Nov 2024 18:09:44 +0000 Subject: [PATCH] Make link text for components and patterns consistent --- src/community/roadmap/index.md | 4 +-- src/components/accordion/index.md | 2 +- src/components/back-link/index.md | 4 +-- src/components/button/index.md | 4 +-- src/components/character-count/index.md | 4 +-- src/components/checkboxes/index.md | 6 ++-- src/components/cookie-banner/index.md | 8 ++--- src/components/date-input/index.md | 2 +- src/components/details/index.md | 2 +- src/components/error-message/index.md | 32 +++++++++---------- src/components/error-summary/index.md | 6 ++-- src/components/exit-this-page/index.md | 4 +-- src/components/fieldset/index.md | 4 +-- src/components/file-upload/index.md | 2 +- src/components/footer/index.md | 2 +- src/components/header/index.md | 12 +++---- src/components/index.md | 2 +- src/components/inset-text/index.md | 2 +- src/components/notification-banner/index.md | 10 +++--- src/components/pagination/index.md | 2 +- src/components/panel/index.md | 2 +- src/components/password-input/index.md | 8 ++--- src/components/phase-banner/index.md | 4 +-- src/components/radios/index.md | 8 ++--- src/components/select/index.md | 2 +- src/components/service-navigation/index.md | 10 +++--- src/components/skip-link/index.md | 2 +- src/components/summary-list/index.md | 4 +-- src/components/tabs/index.md | 2 +- src/components/tag/index.md | 4 +-- src/components/task-list/index.md | 8 ++--- src/components/text-input/index.md | 8 ++--- src/components/textarea/index.md | 10 +++--- .../index.md | 2 +- src/get-started/focus-states/index.md | 4 +-- src/patterns/addresses/index.md | 2 +- src/patterns/bank-details/index.md | 2 +- src/patterns/check-answers/index.md | 2 +- src/patterns/complete-multiple-tasks/index.md | 14 ++++---- .../confirm-an-email-address/index.md | 2 +- .../index.md | 4 +-- src/patterns/cookies-page/index.md | 10 +++--- src/patterns/dates/index.md | 2 +- src/patterns/email-addresses/index.md | 2 +- src/patterns/equality-information/index.md | 2 +- src/patterns/exit-a-page-quickly/index.md | 4 +-- src/patterns/names/index.md | 4 +-- .../national-insurance-numbers/index.md | 4 +-- src/patterns/navigate-a-service/index.md | 22 ++++++------- src/patterns/passwords/index.md | 4 +-- src/patterns/phone-numbers/index.md | 2 +- .../problem-with-the-service-pages/index.md | 2 +- src/patterns/question-pages/index.md | 4 +-- .../service-unavailable-pages/index.md | 2 +- src/patterns/step-by-step-navigation/index.md | 2 +- src/patterns/task-list-pages/index.md | 2 +- .../index.md | 2 +- src/patterns/validation/index.md | 6 ++-- src/styles/headings/index.md | 2 +- src/styles/layout/index.md | 4 +-- src/styles/page-template/index.md | 18 +++++------ 61 files changed, 159 insertions(+), 159 deletions(-) diff --git a/src/community/roadmap/index.md b/src/community/roadmap/index.md index b3a9b96ae6..90eaab79a1 100644 --- a/src/community/roadmap/index.md +++ b/src/community/roadmap/index.md @@ -19,7 +19,7 @@ Last updated 10 October 2024. We’ve released [GOV.UK Frontend v5.7.1](https://github.com/alphagov/govuk-frontend/releases/tag/v5.7.1) with updated department colours. -Previously, we’ve released [GOV.UK Frontend v5.7.0](https://github.com/alphagov/govuk-frontend/releases/tag/v5.7.0), which includes an update to the Royal Arms in the [GOV.UK footer](/components/footer/). We’ve also added new features to help services [create their own JavaScript components using GOV.UK Frontend](https://frontend.design-system.service.gov.uk/building-your-own-javascript-components/). +Previously, we’ve released [GOV.UK Frontend v5.7.0](https://github.com/alphagov/govuk-frontend/releases/tag/v5.7.0), which includes an update to the Royal Arms in the [GOV.UK footer component](/components/footer/). We’ve also added new features to help services [create their own JavaScript components using GOV.UK Frontend](https://frontend.design-system.service.gov.uk/building-your-own-javascript-components/). We’ve also recently: @@ -29,7 +29,7 @@ We’ve also recently: - improved how the Breadcrumbs component appears on screen readers - fixed some alignment issues with Radio buttons and Checkboxes - introduced new features to help you include only the components your service uses -- introduced a new [‘Password input’ component](/components/password-input/) +- introduced a new [Password input component](/components/password-input/) - updated the crown in the header, favicon and social share images - updated the components, patterns and styles to be compliant with WCAG 2.2 - made it easier for teams to understand [what's changed in WCAG 2.2 and what they need to do](/accessibility/wcag-2.2) diff --git a/src/components/accordion/index.md b/src/components/accordion/index.md index 9155a10e47..9b85d733eb 100644 --- a/src/components/accordion/index.md +++ b/src/components/accordion/index.md @@ -50,7 +50,7 @@ Do not use the accordion component if the amount of content inside will make the ## Decide between using accordions, tabs and details -Accordions, [tabs](/components/tabs/) and [details](/components/details/) all work by hiding sections of content which a user can choose to reveal. Avoid using any of these components within one another. +Accordions, the [Tabs component](/components/tabs/) and the [Details component](/components/details/) all work by hiding sections of content which a user can choose to reveal. Avoid using any of these components within one another. If you decide to use one of these components, consider if: diff --git a/src/components/back-link/index.md b/src/components/back-link/index.md index c48c9aebb6..7687d0f86a 100644 --- a/src/components/back-link/index.md +++ b/src/components/back-link/index.md @@ -35,13 +35,13 @@ Although browsers have a back button, some sites break when you use it - so many ## When to use this component -Always include the back link component on GOV.UK [question pages](/patterns/question-pages/). +Always include the back link component on GOV.UK [Question pages](/patterns/question-pages/). You can include a back link on other pages within a multi-page transaction, if it makes sense to do so. ## When not to use this component -Never use the back link component together with [breadcrumbs](/components/breadcrumbs/). If necessary, you should do research with your users to learn which they find more helpful in your service. +Never use the back link component together with the [Breadcrumbs component](/components/breadcrumbs/). If necessary, you should do research with your users to learn which they find more helpful in your service. ## How it works diff --git a/src/components/button/index.md b/src/components/button/index.md index a4b69601fa..8601a1c61c 100644 --- a/src/components/button/index.md +++ b/src/components/button/index.md @@ -40,8 +40,8 @@ Write button text in sentence case, describing the action it performs. For examp - ‘Save and come back later’ when a user can save their information and come back later - ‘Add another’ to add another item to a list or group - ‘Pay’ to make a payment -- ‘Confirm and send’ on a [check answers](/patterns/check-answers/) page that does not have any legal content a user must agree to -- ‘Accept and send’ on a [check answers](/patterns/check-answers/) page that has legal content a user must agree to +- ‘Confirm and send’ on a [Check answers page](/patterns/check-answers/) that does not have any legal content a user must agree to +- ‘Accept and send’ on a [Check answers page](/patterns/check-answers/) that has legal content a user must agree to - ‘Sign out’ when a user is signed in to an account You may need to include more or different words to better describe the action. For example, ‘Add another address’ and ‘Accept and claim a tax refund’. diff --git a/src/components/character-count/index.md b/src/components/character-count/index.md index 917e0d5119..d33f34cd66 100644 --- a/src/components/character-count/index.md +++ b/src/components/character-count/index.md @@ -28,7 +28,7 @@ If your users keep hitting the character limit imposed by the backend of your se ## How it works -It tells users how many characters they have remaining as they type into a [textarea](/components/textarea/) with a character limit. +It tells users how many characters they have remaining as they type into a [Textarea component](/components/textarea/) with a character limit. Users will get updates at a pace that works best for the way they interact with the textarea. This means: @@ -50,7 +50,7 @@ There are 2 ways to use the character count component. You can use HTML or, if y ### If you’re asking more than one question on the page -If you're asking more than one question on the page, do not set the contents of the `