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

docs(cyclebutton): setup for deprecation #2536

Merged
merged 2 commits into from
Feb 16, 2024

Conversation

mdt2
Copy link
Collaborator

@mdt2 mdt2 commented Feb 16, 2024

Description

Preparation for deprecating the cyclebutton component. Includes a small change to docs to recommend markdown syntax for links instead of html (since markdown automatically handles links, vs needing to add classes when using html)

How and where has this been tested?

Please tag yourself on the tests you've marked complete to confirm the tests have been run by someone other than the author.

Validation steps

Check that the steps for flagging a component as deprecated have been completed in this PR:

  • There's a deprecation announcement for cyclebutton
  • In storybook, cyclebutton is in the deprecated section
  • In storybook, cyclebutton has a deprecated status (seen in the toolbar)
  • VRTs on this PR do not include cyclebutton anymore (result of the parameter that disables chromatic)
  • In the docs site, cyclebutton has a deprecation notice at the top (with a link that is dark mode compatible)

Regression testing

Validate:

  1. The documentation pages for at least two other components are still loading, including:
  • The pages render correctly, are accessible, and are responsive.
  1. If components have been modified, VRTs have been run on this branch:
  • VRTs have been run and looked at.
  • Any VRT changes have been accepted (by reviewer and/or PR author), or there are no changes.

Screenshots

To-do list

  • I have read the contribution guidelines.
  • I have updated relevant storybook stories and templates.
  • I have tested these changes in Windows High Contrast mode.
  • If my change impacts other components, I have tested to make sure they don't break.
  • If my change impacts documentation, I have updated the documentation accordingly.
  • ✨ This pull request is ready to merge. ✨

@mdt2 mdt2 force-pushed the mdt2/css-514-setup-cyclebutton-deprecation branch from d057c64 to 3a117ad Compare February 16, 2024 17:01
Copy link
Contributor

github-actions bot commented Feb 16, 2024

🚀 Deployed on https://pr-2536--spectrum-css.netlify.app

Copy link
Contributor

github-actions bot commented Feb 16, 2024

File metrics

Summary

Total size: 3.93 MB*

🎉 No changes detected in any packages

* Size determined by adding together the size of the main file for all packages in the library.
* Results are not gzipped or minified.
* An ASCII character in UTF-8 is 8 bits or 1 byte.

@castastrophe castastrophe merged commit fa56444 into main Feb 16, 2024
21 checks passed
@castastrophe castastrophe deleted the mdt2/css-514-setup-cyclebutton-deprecation branch February 16, 2024 17:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants