Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add deprecation tag #4488

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from
Draft

Add deprecation tag #4488

wants to merge 2 commits into from

Conversation

domoscargin
Copy link
Contributor

@domoscargin domoscargin commented Feb 11, 2025

Use the new option.deprecated field to flag when an option has been deprecated. Optionally (though most commonly), we can also flag the version it was deprecated in and link to the relevant release notes.

Multiple deprecated macro options

We've considered and dismissed other placements of the deprecated tag:

  • In the name field
    • This is a table header cell, so will be read out often on screenreaders - it's better for it be succinct
  • In the table caption
    • We felt that it's too easy to gloss over the table caption and look straight at the options you want to check
  • As a heading above all sub-tables which have been fully deprecated
    • Another case of glossing over, and adds unnecessary code complexity
  • In a seperate column
    • We're a bit pushed for space with these tables

We also considered adding a short message to the deprecation, but found this was too easy to confuse with the existing option description, so opted to link straight out to the relevant release notes instead.

Copy link

netlify bot commented Feb 11, 2025

You can preview this change here:

Name Link
🔨 Latest commit 3073af5
🔍 Latest deploy log https://app.netlify.com/sites/govuk-design-system-preview/deploys/67ae746bc93b4c000843b0eb
😎 Deploy Preview https://deploy-preview-4488--govuk-design-system-preview.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@domoscargin domoscargin force-pushed the bk-deprecation branch 3 times, most recently from 8e10fd9 to ea35484 Compare February 13, 2025 11:34
@domoscargin domoscargin marked this pull request as ready for review February 13, 2025 22:48
@domoscargin domoscargin changed the title WIP: Add deprecation tag Add deprecation tag Feb 17, 2025
@domoscargin domoscargin marked this pull request as draft February 17, 2025 12:02
@domoscargin domoscargin requested a review from a team February 24, 2025 10:08
@domoscargin domoscargin added this to the v5.9.0 milestone Feb 24, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: Needs review 🔍
Development

Successfully merging this pull request may close these issues.

Update website guidance and macro options to deprecate 'Header with service name' variant
1 participant