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

Start documentation for PVC accessibility linting rules #2107

Merged
merged 9 commits into from
Jul 8, 2023

Conversation

khiga8
Copy link
Contributor

@khiga8 khiga8 commented Jun 23, 2023

Authors: Please fill out this form carefully and completely.

Reviewers: By approving this Pull Request you are approving the code change, as well as its deployment and mitigation plans.
Please read this description carefully. If you feel there is anything unclear or missing, please ask for updates.

What are you trying to accomplish?

List the issues that this change affects.

Fixes:https://github.com/github/accessibility/issues/3906

Risk Assessment

  • Low risk the change is small, highly observable, and easily rolled back.
  • Medium risk changes that are isolated, reduced in scope or could impact few users. The change will not impact library availability.
  • High risk changes are those that could impact customers and SLOs, low or no test coverage, low observability, or slow to rollback.

What approach did you choose and why?

This PR introduces migration guidance for the accessibility lint rule we introduced in #2086.

We will link to this page as part of the rule violation message.

Having a page dedicated to explaining the importance of this rule, and migration options may ease migration for consumers.

Anything you want to highlight for special attention from reviewers?

No

  • Added/updated tests
  • Added/updated documentation
  • Added/updated previews (Lookbook)
  • Tested in Chrome
  • Tested in Firefox
  • Tested in Safari
  • Tested in Edge

@changeset-bot
Copy link

changeset-bot bot commented Jun 23, 2023

⚠️ No Changeset found

Latest commit: b879376

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@khiga8 khiga8 temporarily deployed to preview June 23, 2023 17:45 — with GitHub Actions Inactive
@khiga8 khiga8 temporarily deployed to github-pages June 23, 2023 17:51 — with GitHub Actions Inactive
@khiga8 khiga8 temporarily deployed to preview July 6, 2023 17:13 — with GitHub Actions Inactive
@khiga8 khiga8 temporarily deployed to github-pages July 6, 2023 17:18 — with GitHub Actions Inactive
@khiga8 khiga8 force-pushed the kh-introduce-tooltipped-docs branch from 5969cb6 to b4749d8 Compare July 7, 2023 01:52
@khiga8 khiga8 temporarily deployed to preview July 7, 2023 01:52 — with GitHub Actions Inactive
@khiga8 khiga8 temporarily deployed to github-pages July 7, 2023 01:56 — with GitHub Actions Inactive
@khiga8 khiga8 added the skip changeset Pull requests that don't change the library output label Jul 7, 2023
@khiga8 khiga8 temporarily deployed to preview July 7, 2023 13:49 — with GitHub Actions Inactive
@khiga8 khiga8 temporarily deployed to github-pages July 7, 2023 13:53 — with GitHub Actions Inactive
@khiga8 khiga8 marked this pull request as ready for review July 7, 2023 14:00
@khiga8 khiga8 requested review from a team and keithamus July 7, 2023 14:00
@khiga8
Copy link
Contributor Author

khiga8 commented Jul 7, 2023

Idk why the tests are breaking but this is ready.

@khiga8 khiga8 removed the skip changeset Pull requests that don't change the library output label Jul 7, 2023
@khiga8 khiga8 temporarily deployed to preview July 7, 2023 14:01 — with GitHub Actions Inactive
@khiga8 khiga8 temporarily deployed to github-pages July 7, 2023 14:06 — with GitHub Actions Inactive
@khiga8 khiga8 temporarily deployed to preview July 7, 2023 14:23 — with GitHub Actions Inactive
@khiga8 khiga8 temporarily deployed to github-pages July 7, 2023 14:27 — with GitHub Actions Inactive
@khiga8 khiga8 temporarily deployed to github-pages July 7, 2023 15:04 — with GitHub Actions Inactive
@khiga8 khiga8 added skip changeset Pull requests that don't change the library output and removed minor release labels Jul 7, 2023
@khiga8
Copy link
Contributor Author

khiga8 commented Jul 7, 2023

thanks for approving! please merge when appropriate since I am not authorized!

@keithamus keithamus enabled auto-merge (squash) July 7, 2023 16:06
@keithamus keithamus merged commit 0f2809c into main Jul 8, 2023
29 checks passed
@keithamus keithamus deleted the kh-introduce-tooltipped-docs branch July 8, 2023 11:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
minor release skip changeset Pull requests that don't change the library output
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants