Removes and redirects Lighthouse accessibility docs to axe docs. #7404
Conversation
malchata
added
P1
|
@malchata this is awesome. I might have missed the decision somewhere, but also probably good to document in this PR for future code archaeologists: what's the plan with the versioned axe docs? Are we going to just periodically bump the version number (currently 4.4)? If so, I can add notes to the Lighthouse repo that when |
|
I didn't have much of a plan in place, honestly. I figured we'd just bump periodically, but there may be a way to automate a task during build that updates the redirects, but that could be its own horde of dragons to deal with. We can chat about it in the handoff meeting I just scheduled. |
| # TODO - there doesn't seem to be a corresponding axe rule. | ||
| - source: /layout-table/ | ||
| destination: |
There was a problem hiding this comment.
| # TODO - there doesn't seem to be a corresponding axe rule. | |
| - source: /layout-table/ | |
| destination: | |
| - source: /layout-table/ | |
| destination: https://dequeuniversity.com/rules/axe/3.5/layout-table |
layout-table was removed in axe-core 4.0
| # TODO - there doesn't seem to be a corresponding axe rule. | ||
| - source: /audio-caption/ | ||
| destination: |
There was a problem hiding this comment.
| # TODO - there doesn't seem to be a corresponding axe rule. | |
| - source: /audio-caption/ | |
| destination: | |
| - source: /audio-caption/ | |
| destination: https://dequeuniversity.com/rules/axe/3.5/audio-caption |
deprecated in dequelabs/axe-core#1071, removed in axe-core 4.0
| # TODO - there doesn't seem to be a corresponding axe rule. | ||
| - source: /video-description/ | ||
| destination: |
There was a problem hiding this comment.
| # TODO - there doesn't seem to be a corresponding axe rule. | |
| - source: /video-description/ | |
| destination: | |
| - source: /video-description/ | |
| destination: https://dequeuniversity.com/rules/axe/3.3/video-description |
removed in dequelabs/axe-core#1737, axe-core 3.4
| # TODO - there doesn't seem to be a corresponding axe rule. | ||
| - source: /custom-control-roles/ | ||
| destination: |
There was a problem hiding this comment.
The rest of these are so-called manual accessibility audits, things we ask the user to check because the automated tests can't. As a result there are no corresponding axe documents, so I'll need to migrate from web.dev.
Completely forgot about these :/
| - source: /tabindex/ | ||
| destination: https://dequeuniversity.com/rules/axe/4.4/tabindex | ||
| - source: /aria-allowed-attr/ | ||
| destination: https://dequeuniversity.com/rules/axe/4.4/aria-allowed-role |
There was a problem hiding this comment.
| destination: https://dequeuniversity.com/rules/axe/4.4/aria-allowed-role | |
| destination: https://dequeuniversity.com/rules/axe/4.4/aria-allowed-attr |
| - source: /duplicate-id-aria/ | ||
| destination: https://dequeuniversity.com/rules/axe/4.4/duplicate-id-aria | ||
| - source: /button-name/ | ||
| destination: https://dequeuniversity.com/rules/axe/4.4/aria-command-name |
There was a problem hiding this comment.
| destination: https://dequeuniversity.com/rules/axe/4.4/aria-command-name | |
| destination: https://dequeuniversity.com/rules/axe/4.4/button-name |
| @@ -315,3 +315,117 @@ redirects: | |||
| # Redirects old vitals tooling workflow doc to the updated doc | |||
| - source: /vitals-tools-workflow | |||
| destination: /vitals-tools | |||
|
|
|||
| # Redirects for Lighthouse accessibility audits | |||
There was a problem hiding this comment.
maybe worth a comment that Lighthouse will now directly link to the redirect destinations so these are only for existing links and don't need to be updated in the future? Or we can just leave a note on the PR and blame can find it if someone is curious
| destination: | ||
| # TODO - there doesn't seem to be a corresponding axe rule. | ||
| - source: /offscreen-content-hidden/ | ||
| destination: https://dequeuniversity.com/rules/axe/4.4/hidden-content |
There was a problem hiding this comment.
| destination: https://dequeuniversity.com/rules/axe/4.4/hidden-content | |
| destination: |
TODO: migrate https://web.dev/offscreen-content-hidden/
| - source: /offscreen-content-hidden/ | ||
| destination: https://dequeuniversity.com/rules/axe/4.4/hidden-content | ||
| - source: /use-landmarks/ | ||
| destination: https://dequeuniversity.com/rules/axe/4.4/landmark-no-duplicate-main |
There was a problem hiding this comment.
| destination: https://dequeuniversity.com/rules/axe/4.4/landmark-no-duplicate-main | |
| destination: |
TODO: migrate https://web.dev/use-landmarks/
This PR is part of the effort around resolving this issue: GoogleChrome/developer.chrome.com#1997
Changes proposed in this pull request:
Note:
DO NOT MERGElabel will be dropped once it's safe to deploy these changes.