Skip to content

Commit

Permalink
Merge pull request #138 from alphagov/Small-edits
Browse files Browse the repository at this point in the history
small changes, mainly typos
  • Loading branch information
ChristineWuerth authored Dec 10, 2024
2 parents bfc637d + f7241fd commit 8fe08b9
Show file tree
Hide file tree
Showing 10 changed files with 28 additions and 29 deletions.
4 changes: 2 additions & 2 deletions docs/components/attachment.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ howItWorks:
It is intended to be rendered in Govspeak and as an attachment ‘preview’ in Content Publisher. It is not as rich in features as the attachment rendering provided by Whitehall, it lacks support for multiple languages, CSV previews and publication fields.
View this component and all its variations in the <a class="govuk-link" href="https://components.publishing.service.gov.uk/component-guide/attachment" rel="noopener noreferrer" target="_blank">Component Guide (open in a new tab)</a>.'
View this component and all its variations in the <a class="govuk-link" href="https://components.publishing.service.gov.uk/component-guide/attachment" rel="noopener noreferrer" target="_blank">Component Guide (opens in a new tab)</a>.'

# Variations for this component
# List out any variations that exist for this component by providing (1) the name of said variation and (2) a brief description of that variation.
Expand Down Expand Up @@ -194,7 +194,7 @@ accessibilty:
- have meaningful text
Considerations and criteria taken from the <a class="govuk-link" href="https://components.publishing.service.gov.uk/component-guide/attachment#accessibility-acceptance-criteria" rel="noopener noreferrer" target="_blank">Component Guide (open in a new tab)</a>.'
Considerations and criteria taken from the <a class="govuk-link" href="https://components.publishing.service.gov.uk/component-guide/attachment#accessibility-acceptance-criteria" rel="noopener noreferrer" target="_blank">Component Guide (opens in a new tab)</a>.'

# Other design systems
# List out all the other design systems that have documented this exact same component. This includes the GOV.UK Design System, along with other UK government departments.
Expand Down
2 changes: 1 addition & 1 deletion docs/components/breadcrumbs.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ howItWorks:
The component accepts an array of breadcrumb objects. Each crumb must have a title and a URL. Links are tracked, but in Universal Analytics, links to the homepage (any link with a url of `/`) will be tracked separately as `homeLinkClicked`.
View this component and all its variations in the <a class="govuk-link" href="https://components.publishing.service.gov.uk/component-guide/breadcrumbs" rel="noopener noreferrer" target="_blank">Component Guide (open in a new tab)</a>.'
View this component and all its variations in the <a class="govuk-link" href="https://components.publishing.service.gov.uk/component-guide/breadcrumbs" rel="noopener noreferrer" target="_blank">Component Guide (opens in a new tab)</a>.'

# Variations for this component
# List out any variations that exist for this component by providing (1) the name of said variation and (2) a brief description of that variation.
Expand Down
21 changes: 10 additions & 11 deletions docs/components/content-list.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ howItWorks:
It depends on the content type it shows on, but usually this component is rendered based on a publisher-provided list of parts in a document.
View this component and all its variations in the <a class="govuk-link" href="https://components.publishing.service.gov.uk/component-guide/contents_list" rel="noopener noreferrer" target="_blank">Component Guide (open in a new tab)</a>.'
View this component and all its variations in the <a class="govuk-link" href="https://components.publishing.service.gov.uk/component-guide/contents_list" rel="noopener noreferrer" target="_blank">Component Guide (opens in a new tab)</a>.'

# Variations for this component
# List out any variations that exist for this component by providing (1) the name of said variation and (2) a brief description of that variation.
Expand Down Expand Up @@ -129,6 +129,14 @@ howItWorks:
insights:
# To add additional insights duplicate the the fields below (adhering to the formating) but increase the count by one integer.
0:
# Both title and link are REQUIRED in order for this information to render on the page.
date: November 2021
description:
# You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. To create a heading, use three hashes (ie. ###).
'A research project in context of a new page level design explored “How are users who need to *advise on a thing* orientating themselves and navigating at a content page level?”. Under “Chapter scanning and hopping” it summarises that “Participants displayed a strong inclination to engage with table-of-contents style links, which allow them to move across different sections within a piece of content.” The research was done on users that advise others on building works.'
title: Navigational behaviours – Chapter scanning and hopping – GOV.UK Explore – Research Round 5
link: https://docs.google.com/presentation/d/1wsiH0OJPyS9DtxvUXri-tNkqFhU6N00xjdsWSAHK2Fw/edit#slide=id.g1006224b8f4_0_85
1:
# Both title and link are REQUIRED in order for this information to render on the page.
date: August 2022
description:
Expand All @@ -137,15 +145,6 @@ insights:
title: Content Audit Discovery – Component recommendations
link: https://docs.google.com/document/d/1Gb3P2lQVGjdfhBnz19FDX4coWTpbKGIpZABNnQ7iLl0/edit#heading=h.llzp42bd0b76
documentFormat: Google Docs
1:
# Both title and link are REQUIRED in order for this information to render on the page.
date: November 2022
description:
# You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. To create a heading, use three hashes (ie. ###).
'A research project in context of a new page level design explored “How are users who need to *advise on a thing* orientating themselves and navigating at a content page level?”. Under “Chapter scanning and hopping” it summarises that “Participants displayed a strong inclination to engage with table-of-contents style links, which allow them to move across different sections within a piece of content.” The research was done on users that advise others on building works.'
title: Navigational behaviours – Chapter scanning and hopping – GOV.UK Explore – Research Round 5
link: https://docs.google.com/presentation/d/1wsiH0OJPyS9DtxvUXri-tNkqFhU6N00xjdsWSAHK2Fw/edit#slide=id.g1006224b8f4_0_85
documentFormat: Google Slides
2:
# Both title and link are REQUIRED in order for this information to render on the page.
date: May 2024
Expand Down Expand Up @@ -200,7 +199,7 @@ accessibilty:
- have meaningful text
Considerations and criteria taken from the <a class="govuk-link" href="https://components.publishing.service.gov.uk/component-guide/contents_list#accessibility-acceptance-criteria" rel="noopener noreferrer" target="_blank">Component Guide (open in a new tab)</a>.'
Considerations and criteria taken from the <a class="govuk-link" href="https://components.publishing.service.gov.uk/component-guide/contents_list#accessibility-acceptance-criteria" rel="noopener noreferrer" target="_blank">Component Guide (opens in a new tab)</a>.'

# Other design systems
# List out all the other design systems that have documented this exact same component. This includes the GOV.UK Design System, along with other UK government departments.
Expand Down
2 changes: 1 addition & 1 deletion docs/components/feedback.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ howItWorks:
This component uses JavaScript for expanding and collapsing and also for submitting form responses.
View this component and all its variations in the <a class="govuk-link" href="https://components.publishing.service.gov.uk/component-guide/feedback" rel="noopener noreferrer" target="_blank">Component Guide (open in a new tab)</a>.'
View this component and all its variations in the <a class="govuk-link" href="https://components.publishing.service.gov.uk/component-guide/feedback" rel="noopener noreferrer" target="_blank">Component Guide (opens in a new tab)</a>.'

# Variations for this component
# List out any variations that exist for this component by providing (1) the name of said variation and (2) a brief description of that variation.
Expand Down
2 changes: 1 addition & 1 deletion docs/components/global-banner.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ howItWorks:
'A site-wide (global) banner can be activated to convey important information on GOV.UK which is not deemed emergency-level information. Unlike the emergency banner, we show a user the global banner no more than 3 times, by storing the view count in a cookie.
Information and image of this component is available on the <a class="govuk-link" href="https://docs.publishing.service.gov.uk/manual/global-banner.html" rel="noopener noreferrer" target="_blank">Developer docs (open in a new tab)</a>.'
Information and image of this component is available on the <a class="govuk-link" href="https://docs.publishing.service.gov.uk/manual/global-banner.html" rel="noopener noreferrer" target="_blank">Developer docs (opens in a new tab)</a>.'

# Variations for this component
# List out any variations that exist for this component by providing (1) the name of said variation and (2) a brief description of that variation.
Expand Down
2 changes: 1 addition & 1 deletion docs/components/print-link.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ howItWorks:
'This component renders two different outputs depending on whether a `href` is specified. By default, when no `href` is given, the component renders as a button and triggers a print action via JavaScript. In this case the component is hidden in environments where JavaScript is disabled and can be used as a progressive enhancement. When a `href` is specified the component renders as an anchor tag and navigates to that `href` without JavaScript, suitable for applications which have paths that trigger a print event on load.
View this component and all its variations in the <a class="govuk-link" href="https://components.publishing.service.gov.uk/component-guide/print_link" rel="noopener noreferrer" target="_blank">Component Guide (open in a new tab)</a>.'
View this component and all its variations in the <a class="govuk-link" href="https://components.publishing.service.gov.uk/component-guide/print_link" rel="noopener noreferrer" target="_blank">Component Guide (opens in a new tab)</a>.'

# Variations for this component
# List out any variations that exist for this component by providing (1) the name of said variation and (2) a brief description of that variation.
Expand Down
2 changes: 1 addition & 1 deletion docs/components/single-page-notification-button.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ howItWorks:
[Example](https://www.gov.uk/email/subscriptions/single-page/new?topic_id=download-the-hmrc-app)
View this component and all its variations in the <a class="govuk-link" href="https://components.publishing.service.gov.uk/component-guide/single_page_notification_button" rel="noopener noreferrer" target="_blank">Component Guide (open in a new tab)</a>.'
View this component and all its variations in the <a class="govuk-link" href="https://components.publishing.service.gov.uk/component-guide/single_page_notification_button" rel="noopener noreferrer" target="_blank">Component Guide (opens in a new tab)</a>.'

# Variations for this component
# List out any variations that exist for this component by providing (1) the name of said variation and (2) a brief description of that variation.
Expand Down
8 changes: 4 additions & 4 deletions docs/frontend-templates/document-collections.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ title: Document collections

# Description of the frontend template
# This briefly describes what the frontend template is. It is required to display the description on the page, and in the <head> meta description.
description: Document collections group related documents on a single page that are aimed for a specific audience or around a specific theme or topic.
description: Document collections group related documents on a single page that are aimed at a specific audience or reflect a specific theme or topic.

# Embedding the figma file of the frontend template
# This will display a Figma embed on the page.
Expand Down Expand Up @@ -51,10 +51,10 @@ howItWorks:
### Rules on how multiple collections are ordered
If more than one collection page is listed, the collections appear in the order of their relative positions within the document collections they belong to.
If more than one collection page is listed, they are ordered by the respective item’s position within them.
Example: [National curriculum in England: framework for key stages 1 to 4](https://www.gov.uk/government/publications/national-curriculum-in-england-framework-for-key-stages-1-to-4) - The content item belongs to 3 document collections. It’s the first item in "National curriculum", so that document collection appears first in the list. It’s the 17th item in the "Schools: statutory guidance" document collection - so is the second link in the sidebar. It is the 54th item in the "Local-authority-maintained schools: governance" collection - so that is the third link.
Example: The content item [National curriculum in England: framework for key stages 1 to 4](https://www.gov.uk/government/publications/national-curriculum-in-england-framework-for-key-stages-1-to-4) belongs to 3 document collections. It’s the first item in "National curriculum", so that document collection appears first in the list. It’s the 17th item in the "Schools: statutory guidance" document collection, making this the second link in the sidebar. It is also the 54th item in the "Local-authority-maintained schools: governance" collection, therefore showing this as the third link.
### Email sign up links on document collections
Expand All @@ -67,7 +67,7 @@ howItWorks:
- the document collection is unpublished and redirected
There’s an exception on some HMRC document collections where users will get emails about the topic instead of the document collection. [Find out why they were set up like this](https://docs.google.com/document/d/1MR5OaFG_DOCmWGL9o9MSGIPLMFe2mmSrV6Va-99cSzw/edit#heading=h.jbja48mpt1t7).'
There’s an exception on some HMRC document collections where users will get emails about the topic instead of the document collection. <a class="govuk-link" href="https://docs.google.com/document/d/1MR5OaFG_DOCmWGL9o9MSGIPLMFe2mmSrV6Va-99cSzw/edit#heading=h.jbja48mpt1t7" rel="noopener noreferrer" target="_blank">Find out why they were set up like this (opens in a new tab)</a>.'

# Live examples of webpages that use this frontend template
# List out all the pages on GOV.UK that use this frontend template, by providing: (1) the title of the page, (2) the URL of the page, and (3) indicate whether the page is in Welsh in order for assistive technology to read out the page title correctly.
Expand Down
10 changes: 5 additions & 5 deletions docs/frontend-templates/mainstream-browse/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,9 +36,9 @@ figmaLink: #Delete this comment before entering the Figma embed URL of the Figma
howItWorks:
'There are two levels of mainstream browse pages:
- [Level one](./level-one) - Topic (parent)
- [Level one](./level-one) Topic (parent)
- [Level two](./level-two) - Subtopic (child)
- [Level two](./level-two) Subtopic (child)
Mainstream browse topics are listed in the main menu and on the GOV.UK homepage under ‘Services and information’ heading.'
Expand All @@ -49,7 +49,7 @@ examples:
# To add additional examples duplicate the the fields below (adhering to the formating) but increase the count by one integer.
0:
# Both title and link are REQUIRED in order for this information to render on the page.
title: 'Driving and transport - Level one browse page'
title: 'Driving and transport Level one browse page'
link: https://www.gov.uk/browse/driving
welsh:
# Options on whether the webpage using this frontend template is in Welsh:
Expand All @@ -58,7 +58,7 @@ examples:
false
1:
# Both title and link are REQUIRED in order for this information to render on the page.
title: 'Vehicle, tax MOT and insurance - Curated level two browse page'
title: 'Vehicle, tax MOT and insurance Curated level two browse page'
link: https://www.gov.uk/browse/driving/vehicle-tax-mot-insurance
welsh:
# Options on whether the webpage using this frontend template is in Welsh:
Expand All @@ -67,7 +67,7 @@ examples:
false
2:
# Both title and link are REQUIRED in order for this information to render on the page.
title: 'School admissions and transport to school - Alphabetical level two browse page'
title: 'School admissions and transport to school Alphabetical level two browse page'
link: https://www.gov.uk/browse/education/school-admissions-transport
welsh:
# Options on whether the webpage using this frontend template is in Welsh:
Expand Down
4 changes: 2 additions & 2 deletions docs/frontend-templates/mainstream-browse/level-two.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ examples:
# To add additional examples duplicate the the fields below (adhering to the formating) but increase the count by one integer.
0:
# Both title and link are REQUIRED in order for this information to render on the page.
title: 'Curated level two browse page - Vehicle, tax MOT and insurance'
title: 'Curated level two browse page Vehicle, tax MOT and insurance'
link: https://www.gov.uk/browse/driving/vehicle-tax-mot-insurance
welsh:
# Options on whether the webpage using this frontend template is in Welsh:
Expand All @@ -51,7 +51,7 @@ examples:
false
1:
# Both title and link are REQUIRED in order for this information to render on the page.
title: 'Alphabetical level two browse page - School admissions and transport to school'
title: 'Alphabetical level two browse page School admissions and transport to school'
link: https://www.gov.uk/browse/education/school-admissions-transport
welsh:
# Options on whether the webpage using this frontend template is in Welsh:
Expand Down

0 comments on commit 8fe08b9

Please sign in to comment.