Skip to content

Commit

Permalink
core(audits): Point a11y audit doc links to web.dev (#9084)
Browse files Browse the repository at this point in the history
  • Loading branch information
mfriesenhahn authored and paulirish committed Jul 25, 2019
1 parent 9cbfa47 commit 7e26001
Show file tree
Hide file tree
Showing 50 changed files with 208 additions and 208 deletions.
2 changes: 1 addition & 1 deletion lighthouse-core/audits/accessibility/accesskeys.js
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ const UIStrings = {
/** Description of a Lighthouse audit that tells the user *why* they should try to pass. This is displayed after a user expands the section to see more. No character length limits. 'Learn More' becomes link text to additional documentation. */
description: 'Access keys let users quickly focus a part of the page. For proper ' +
'navigation, each access key must be unique. ' +
'[Learn more](https://dequeuniversity.com/rules/axe/3.1/accesskeys?application=lighthouse).',
'[Learn more](https://web.dev/accesskeys/).',
};

const str_ = i18n.createMessageInstanceIdFn(__filename, UIStrings);
Expand Down
2 changes: 1 addition & 1 deletion lighthouse-core/audits/accessibility/aria-allowed-attr.js
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ const UIStrings = {
/** Description of a Lighthouse audit that tells the user *why* they should try to pass. This is displayed after a user expands the section to see more. No character length limits. 'Learn More' becomes link text to additional documentation. */
description: 'Each ARIA `role` supports a specific subset of `aria-*` attributes. ' +
'Mismatching these invalidates the `aria-*` attributes. [Learn ' +
'more](https://dequeuniversity.com/rules/axe/3.1/aria-allowed-attr?application=lighthouse).',
'more](https://web.dev/aria-allowed-attr/).',
};

const str_ = i18n.createMessageInstanceIdFn(__filename, UIStrings);
Expand Down
2 changes: 1 addition & 1 deletion lighthouse-core/audits/accessibility/aria-required-attr.js
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ const UIStrings = {
failureTitle: '`[role]`s do not have all required `[aria-*]` attributes',
/** Description of a Lighthouse audit that tells the user *why* they should try to pass. This is displayed after a user expands the section to see more. No character length limits. 'Learn More' becomes link text to additional documentation. */
description: 'Some ARIA roles have required attributes that describe the state ' +
'of the element to screen readers. [Learn more](https://dequeuniversity.com/rules/axe/3.1/aria-required-attr?application=lighthouse).',
'of the element to screen readers. [Learn more](https://web.dev/aria-required-attr/).',
};

const str_ = i18n.createMessageInstanceIdFn(__filename, UIStrings);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ const UIStrings = {
/** Description of a Lighthouse audit that tells the user *why* they should try to pass. This is displayed after a user expands the section to see more. No character length limits. 'Learn More' becomes link text to additional documentation. */
description: 'Some ARIA parent roles must contain specific child roles to perform ' +
'their intended accessibility functions. ' +
'[Learn more](https://dequeuniversity.com/rules/axe/3.1/aria-required-children?application=lighthouse).',
'[Learn more](https://web.dev/aria-required-children/).',
};

const str_ = i18n.createMessageInstanceIdFn(__filename, UIStrings);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ const UIStrings = {
/** Description of a Lighthouse audit that tells the user *why* they should try to pass. This is displayed after a user expands the section to see more. No character length limits. 'Learn More' becomes link text to additional documentation. */
description: 'Some ARIA child roles must be contained by specific parent roles to ' +
'properly perform their intended accessibility functions. ' +
'[Learn more](https://dequeuniversity.com/rules/axe/3.1/aria-required-parent?application=lighthouse).',
'[Learn more](https://web.dev/aria-required-parent/).',
};

const str_ = i18n.createMessageInstanceIdFn(__filename, UIStrings);
Expand Down
2 changes: 1 addition & 1 deletion lighthouse-core/audits/accessibility/aria-roles.js
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ const UIStrings = {
/** Description of a Lighthouse audit that tells the user *why* they should try to pass. This is displayed after a user expands the section to see more. No character length limits. 'Learn More' becomes link text to additional documentation. */
description: 'ARIA roles must have valid values in order to perform their ' +
'intended accessibility functions. ' +
'[Learn more](https://dequeuniversity.com/rules/axe/3.1/aria-roles?application=lighthouse).',
'[Learn more](https://web.dev/aria-roles/).',
};

const str_ = i18n.createMessageInstanceIdFn(__filename, UIStrings);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ const UIStrings = {
/** Description of a Lighthouse audit that tells the user *why* they should try to pass. This is displayed after a user expands the section to see more. No character length limits. 'Learn More' becomes link text to additional documentation. */
description: 'Assistive technologies, like screen readers, can\'t interpret ARIA ' +
'attributes with invalid values. [Learn ' +
'more](https://dequeuniversity.com/rules/axe/3.1/aria-valid-attr-value?application=lighthouse).',
'more](https://web.dev/aria-valid-attr-value/).',
};

const str_ = i18n.createMessageInstanceIdFn(__filename, UIStrings);
Expand Down
2 changes: 1 addition & 1 deletion lighthouse-core/audits/accessibility/aria-valid-attr.js
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ const UIStrings = {
/** Description of a Lighthouse audit that tells the user *why* they should try to pass. This is displayed after a user expands the section to see more. No character length limits. 'Learn More' becomes link text to additional documentation. */
description: 'Assistive technologies, like screen readers, can\'t interpret ARIA ' +
'attributes with invalid names. [Learn ' +
'more](https://dequeuniversity.com/rules/axe/3.1/aria-valid-attr?application=lighthouse).',
'more](https://web.dev/aria-valid-attr/).',
};

const str_ = i18n.createMessageInstanceIdFn(__filename, UIStrings);
Expand Down
2 changes: 1 addition & 1 deletion lighthouse-core/audits/accessibility/audio-caption.js
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ const UIStrings = {
description: 'Captions make audio elements usable for deaf or hearing-impaired users, ' +
'providing critical information such as who is talking, what they\'re saying, ' +
'and other non-speech information. ' +
'[Learn more](https://dequeuniversity.com/rules/axe/3.1/audio-caption?application=lighthouse).',
'[Learn more](https://web.dev/audio-caption/).',
};

const str_ = i18n.createMessageInstanceIdFn(__filename, UIStrings);
Expand Down
2 changes: 1 addition & 1 deletion lighthouse-core/audits/accessibility/button-name.js
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ const UIStrings = {
/** Description of a Lighthouse audit that tells the user *why* they should try to pass. This is displayed after a user expands the section to see more. No character length limits. 'Learn More' becomes link text to additional documentation. */
description: 'When a button doesn\'t have an accessible name, screen readers announce it ' +
'as "button", making it unusable for users who rely on screen readers. ' +
'[Learn more](https://dequeuniversity.com/rules/axe/3.1/button-name?application=lighthouse).',
'[Learn more](https://web.dev/button-name/).',
};

const str_ = i18n.createMessageInstanceIdFn(__filename, UIStrings);
Expand Down
2 changes: 1 addition & 1 deletion lighthouse-core/audits/accessibility/bypass.js
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ const UIStrings = {
/** Description of a Lighthouse audit that tells the user *why* they should try to pass. This is displayed after a user expands the section to see more. No character length limits. 'Learn More' becomes link text to additional documentation. */
description: 'Adding ways to bypass repetitive content lets keyboard users navigate the ' +
'page more efficiently. ' +
'[Learn more](https://dequeuniversity.com/rules/axe/3.1/bypass?application=lighthouse).',
'[Learn more](https://web.dev/bypass/).',
};

const str_ = i18n.createMessageInstanceIdFn(__filename, UIStrings);
Expand Down
2 changes: 1 addition & 1 deletion lighthouse-core/audits/accessibility/color-contrast.js
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ const UIStrings = {
'sufficient contrast ratio.',
/** Description of a Lighthouse audit that tells the user *why* they should try to pass. This is displayed after a user expands the section to see more. No character length limits. 'Learn More' becomes link text to additional documentation. */
description: 'Low-contrast text is difficult or impossible for many users to read. ' +
'[Learn more](https://dequeuniversity.com/rules/axe/3.1/color-contrast?application=lighthouse).',
'[Learn more](https://web.dev/color-contrast/).',
};

const str_ = i18n.createMessageInstanceIdFn(__filename, UIStrings);
Expand Down
2 changes: 1 addition & 1 deletion lighthouse-core/audits/accessibility/definition-list.js
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ const UIStrings = {
/** Description of a Lighthouse audit that tells the user *why* they should try to pass. This is displayed after a user expands the section to see more. No character length limits. 'Learn More' becomes link text to additional documentation. */
description: 'When definition lists are not properly marked up, screen readers may produce ' +
'confusing or inaccurate output. ' +
'[Learn more](https://dequeuniversity.com/rules/axe/3.1/definition-list?application=lighthouse).',
'[Learn more](https://web.dev/definition-list/).',
};

const str_ = i18n.createMessageInstanceIdFn(__filename, UIStrings);
Expand Down
2 changes: 1 addition & 1 deletion lighthouse-core/audits/accessibility/dlitem.js
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ const UIStrings = {
/** Description of a Lighthouse audit that tells the user *why* they should try to pass. This is displayed after a user expands the section to see more. No character length limits. 'Learn More' becomes link text to additional documentation. */
description: 'Definition list items (`<dt>` and `<dd>`) must be wrapped in a ' +
'parent `<dl>` element to ensure that screen readers can properly announce them. ' +
'[Learn more](https://dequeuniversity.com/rules/axe/3.1/dlitem?application=lighthouse).',
'[Learn more](https://web.dev/dlitem/).',
};

const str_ = i18n.createMessageInstanceIdFn(__filename, UIStrings);
Expand Down
2 changes: 1 addition & 1 deletion lighthouse-core/audits/accessibility/document-title.js
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ const UIStrings = {
/** Description of a Lighthouse audit that tells the user *why* they should try to pass. This is displayed after a user expands the section to see more. No character length limits. 'Learn More' becomes link text to additional documentation. */
description: 'The title gives screen reader users an overview of the page, and search ' +
'engine users rely on it heavily to determine if a page is relevant to their search. ' +
'[Learn more](https://developers.google.com/web/tools/lighthouse/audits/title).',
'[Learn more](https://web.dev/document-title/).',
};

const str_ = i18n.createMessageInstanceIdFn(__filename, UIStrings);
Expand Down
2 changes: 1 addition & 1 deletion lighthouse-core/audits/accessibility/duplicate-id.js
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ const UIStrings = {
/** Description of a Lighthouse audit that tells the user *why* they should try to pass. This is displayed after a user expands the section to see more. No character length limits. 'Learn More' becomes link text to additional documentation. */
description: 'The value of an id attribute must be unique to prevent ' +
'other instances from being overlooked by assistive technologies. ' +
'[Learn more](https://dequeuniversity.com/rules/axe/3.1/duplicate-id?application=lighthouse).',
'[Learn more](https://web.dev/duplicate-id/).',
};

const str_ = i18n.createMessageInstanceIdFn(__filename, UIStrings);
Expand Down
2 changes: 1 addition & 1 deletion lighthouse-core/audits/accessibility/frame-title.js
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ const UIStrings = {
failureTitle: '`<frame>` or `<iframe>` elements do not have a title',
/** Description of a Lighthouse audit that tells the user *why* they should try to pass. This is displayed after a user expands the section to see more. No character length limits. 'Learn More' becomes link text to additional documentation. */
description: 'Screen reader users rely on frame titles to describe the contents of frames. ' +
'[Learn more](https://dequeuniversity.com/rules/axe/3.1/frame-title?application=lighthouse).',
'[Learn more](https://web.dev/frame-title/).',
};

const str_ = i18n.createMessageInstanceIdFn(__filename, UIStrings);
Expand Down
2 changes: 1 addition & 1 deletion lighthouse-core/audits/accessibility/html-has-lang.js
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ const UIStrings = {
'that the page is in the default language that the user chose when setting up the ' +
'screen reader. If the page isn\'t actually in the default language, then the screen ' +
'reader might not announce the page\'s text correctly. ' +
'[Learn more](https://dequeuniversity.com/rules/axe/3.1/html-has-lang?application=lighthouse).',
'[Learn more](https://web.dev/html-has-lang/).',
};

const str_ = i18n.createMessageInstanceIdFn(__filename, UIStrings);
Expand Down
2 changes: 1 addition & 1 deletion lighthouse-core/audits/accessibility/html-lang-valid.js
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ const UIStrings = {
/** Description of a Lighthouse audit that tells the user *why* they should try to pass. This is displayed after a user expands the section to see more. No character length limits. 'Learn More' becomes link text to additional documentation. */
description: 'Specifying a valid [BCP 47 language](https://www.w3.org/International/questions/qa-choosing-language-tags#question) ' +
'helps screen readers announce text properly. ' +
'[Learn more](https://dequeuniversity.com/rules/axe/3.1/valid-lang?application=lighthouse).',
'[Learn more](https://web.dev/html-lang-valid/).',
};

const str_ = i18n.createMessageInstanceIdFn(__filename, UIStrings);
Expand Down
2 changes: 1 addition & 1 deletion lighthouse-core/audits/accessibility/image-alt.js
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ const UIStrings = {
/** Description of a Lighthouse audit that tells the user *why* they should try to pass. This is displayed after a user expands the section to see more. No character length limits. 'Learn More' becomes link text to additional documentation. */
description: 'Informative elements should aim for short, descriptive alternate text. ' +
'Decorative elements can be ignored with an empty alt attribute. ' +
'[Learn more](https://dequeuniversity.com/rules/axe/3.1/image-alt?application=lighthouse).',
'[Learn more](https://web.dev/image-alt/).',
};

const str_ = i18n.createMessageInstanceIdFn(__filename, UIStrings);
Expand Down
2 changes: 1 addition & 1 deletion lighthouse-core/audits/accessibility/input-image-alt.js
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ const UIStrings = {
/** Description of a Lighthouse audit that tells the user *why* they should try to pass. This is displayed after a user expands the section to see more. No character length limits. 'Learn More' becomes link text to additional documentation. */
description: 'When an image is being used as an `<input>` button, providing alternative ' +
'text can help screen reader users understand the purpose of the button. ' +
'[Learn more](https://dequeuniversity.com/rules/axe/3.1/input-image-alt?application=lighthouse).',
'[Learn more](https://web.dev/input-image-alt/).',
};

const str_ = i18n.createMessageInstanceIdFn(__filename, UIStrings);
Expand Down
2 changes: 1 addition & 1 deletion lighthouse-core/audits/accessibility/label.js
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ const UIStrings = {
/** Description of a Lighthouse audit that tells the user *why* they should try to pass. This is displayed after a user expands the section to see more. No character length limits. 'Learn More' becomes link text to additional documentation. */
description: 'Labels ensure that form controls are announced properly by assistive ' +
'technologies, like screen readers. [Learn ' +
'more](https://dequeuniversity.com/rules/axe/3.1/label?application=lighthouse).',
'more](https://web.dev/label/).',
};

const str_ = i18n.createMessageInstanceIdFn(__filename, UIStrings);
Expand Down
2 changes: 1 addition & 1 deletion lighthouse-core/audits/accessibility/layout-table.js
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ const UIStrings = {
description: 'A table being used for layout purposes should not include data elements, ' +
'such as the th or caption elements or the summary attribute, because this can ' +
'create a confusing experience for screen reader users. ' +
'[Learn more](https://dequeuniversity.com/rules/axe/3.1/layout-table?application=lighthouse).',
'[Learn more](https://web.dev/layout-table/).',
};

const str_ = i18n.createMessageInstanceIdFn(__filename, UIStrings);
Expand Down
2 changes: 1 addition & 1 deletion lighthouse-core/audits/accessibility/link-name.js
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ const UIStrings = {
description: 'Link text (and alternate text for images, when used as links) that is ' +
'discernible, unique, and focusable improves the navigation experience for ' +
'screen reader users. ' +
'[Learn more](https://dequeuniversity.com/rules/axe/3.1/link-name?application=lighthouse).',
'[Learn more](https://web.dev/link-name/).',
};

const str_ = i18n.createMessageInstanceIdFn(__filename, UIStrings);
Expand Down
2 changes: 1 addition & 1 deletion lighthouse-core/audits/accessibility/list.js
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ const UIStrings = {
/** Description of a Lighthouse audit that tells the user *why* they should try to pass. This is displayed after a user expands the section to see more. No character length limits. 'Learn More' becomes link text to additional documentation. */
description: 'Screen readers have a specific way of announcing lists. Ensuring proper list ' +
'structure aids screen reader output. ' +
'[Learn more](https://dequeuniversity.com/rules/axe/3.1/list?application=lighthouse).',
'[Learn more](https://web.dev/list/).',
};

const str_ = i18n.createMessageInstanceIdFn(__filename, UIStrings);
Expand Down
2 changes: 1 addition & 1 deletion lighthouse-core/audits/accessibility/listitem.js
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ const UIStrings = {
/** Description of a Lighthouse audit that tells the user *why* they should try to pass. This is displayed after a user expands the section to see more. No character length limits. 'Learn More' becomes link text to additional documentation. */
description: 'Screen readers require list items (`<li>`) to be contained within a ' +
'parent `<ul>` or `<ol>` to be announced properly. ' +
'[Learn more](https://dequeuniversity.com/rules/axe/3.1/listitem?application=lighthouse).',
'[Learn more](https://web.dev/listitem/).',
};

const str_ = i18n.createMessageInstanceIdFn(__filename, UIStrings);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ class CustomControlsLabels extends ManualAudit {
static get meta() {
return Object.assign({
id: 'custom-controls-labels',
description: 'Custom interactive controls have associated labels, provided by aria-label or aria-labelledby. [Learn more](https://developers.google.com/web/fundamentals/accessibility/how-to-review#try_it_with_a_screen_reader).',
description: 'Custom interactive controls have associated labels, provided by aria-label or aria-labelledby. [Learn more](https://web.dev/custom-controls-labels/).',
title: 'Custom controls have associated labels',
}, super.partialMeta);
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ class CustomControlsRoles extends ManualAudit {
static get meta() {
return Object.assign({
id: 'custom-controls-roles',
description: 'Custom interactive controls have appropriate ARIA roles. [Learn more](https://developers.google.com/web/fundamentals/accessibility/how-to-review#try_it_with_a_screen_reader).',
description: 'Custom interactive controls have appropriate ARIA roles. [Learn more](https://web.dev/custom-control-roles/).',
title: 'Custom controls have ARIA roles',
}, super.partialMeta);
}
Expand Down
2 changes: 1 addition & 1 deletion lighthouse-core/audits/accessibility/manual/focus-traps.js
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ class FocusTraps extends ManualAudit {
static get meta() {
return Object.assign({
id: 'focus-traps',
description: 'A user can tab into and out of any control or region without accidentally trapping their focus. [Learn more](https://developers.google.com/web/fundamentals/accessibility/how-to-review#start_with_the_keyboard).',
description: 'A user can tab into and out of any control or region without accidentally trapping their focus. [Learn more](https://web.dev/focus-traps/).',
title: 'User focus is not accidentally trapped in a region',
}, super.partialMeta);
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ class FocusableControls extends ManualAudit {
static get meta() {
return Object.assign({
id: 'focusable-controls',
description: 'Custom interactive controls are keyboard focusable and display a focus indicator. [Learn more](https://developers.google.com/web/fundamentals/accessibility/how-to-review#start_with_the_keyboard).',
description: 'Custom interactive controls are keyboard focusable and display a focus indicator. [Learn more](https://web.dev/focusable-controls/).',
title: 'Interactive controls are keyboard focusable',
}, super.partialMeta);
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ class HeadingLevels extends ManualAudit {
static get meta() {
return Object.assign({
id: 'heading-levels',
description: 'Headings are used to create an outline for the page and heading levels are not skipped. [Learn more](https://developers.google.com/web/fundamentals/accessibility/how-to-review#take_advantage_of_headings_and_landmarks).',
description: 'Headings are used to create an outline for the page and heading levels are not skipped. [Learn more](https://web.dev/heading-levels/).',
title: 'Headings don\'t skip levels',
}, super.partialMeta);
}
Expand Down
Loading

0 comments on commit 7e26001

Please sign in to comment.