Merge pull request #4447 from alphagov/add-a-description-for-the-meta…

…data-block-see-updates-link-example Add a description for the metadata block 'see_updates_link' example
alphagov · Nov 28, 2024 · 34eeb91 · 34eeb91
2 parents 67f4b59 + 5400d61
commit 34eeb91
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 0 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -10,6 +10,7 @@
 ## Unreleased
 
 * Add 'toggle' module to each expandable region in metadata component ([PR #4397](https://github.com/alphagov/govuk_publishing_components/pull/4397))
+* Add a description for the metadata block 'see_updates_link' example ([PR #4447](https://github.com/alphagov/govuk_publishing_components/pull/4447))
 
 ## 45.9.0
 

diff --git a/app/views/govuk_publishing_components/components/docs/metadata.yml b/app/views/govuk_publishing_components/components/docs/metadata.yml
@@ -26,6 +26,9 @@ examples:
       first_published: 14 June 2014
       last_updated: 10 September 2015
   updated_with_links_to_see_details:
+    description: If a `last_updated` value exists and `see_updates_link` is set to true,
+      a "See all updates" link will be shown. The link's href will be set to `#full-publication-update-history`,
+      taking users to the change history on the same page and expanding the section, if expandable, for example, [changes to the rates of capital gains tax](https://www.gov.uk/government/publications/changes-to-the-rates-of-capital-gains-tax)
     data:
       last_updated: 10 September 2015
       see_updates_link: true