Skip to content

Commit

Permalink
core(audits): point perf audit description links to web.dev (#9540)
Browse files Browse the repository at this point in the history
  • Loading branch information
mfriesenhahn authored and brendankenny committed Sep 27, 2019
1 parent 6dde98c commit da334b8
Show file tree
Hide file tree
Showing 31 changed files with 136 additions and 136 deletions.
2 changes: 1 addition & 1 deletion lighthouse-core/audits/bootup-time.js
Expand Up @@ -20,7 +20,7 @@ const UIStrings = {
/** Description of a Lighthouse audit that tells the user that they should reduce the amount of time spent executing javascript and one method of doing so. 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: 'Consider reducing the time spent parsing, compiling, and executing JS. ' +
'You may find delivering smaller JS payloads helps with this. [Learn ' +
'more](https://developers.google.com/web/tools/lighthouse/audits/bootup).',
'more](https://web.dev/bootup-time).',
/** Label for the total time column in a data table; entries will be the number of milliseconds spent executing per resource loaded by the page. */
columnTotal: 'Total CPU Time',
/** Label for a time column in a data table; entries will be the number of milliseconds spent evaluating script for every script loaded by the page. */
Expand Down
Expand Up @@ -18,7 +18,7 @@ const UIStrings = {
/** Description of a Lighthouse audit that tells the user *why* they should use video instead of GIF format for delivering animated content. 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: 'Large GIFs are inefficient for delivering animated content. Consider using ' +
'MPEG4/WebM videos for animations and PNG/WebP for static images instead of GIF to save ' +
'network bytes. [Learn more](https://developers.google.com/web/fundamentals/performance/optimizing-content-efficiency/replace-animated-gifs-with-video/)',
'network bytes. [Learn more](https://web.dev/efficient-animated-content)',
};

const str_ = i18n.createMessageInstanceIdFn(__filename, UIStrings);
Expand Down
2 changes: 1 addition & 1 deletion lighthouse-core/audits/byte-efficiency/offscreen-images.js
Expand Up @@ -23,7 +23,7 @@ const UIStrings = {
description:
'Consider lazy-loading offscreen and hidden images after all critical resources have ' +
'finished loading to lower time to interactive. ' +
'[Learn more](https://developers.google.com/web/tools/lighthouse/audits/offscreen-images).',
'[Learn more](https://web.dev/offscreen-images).',
};

const str_ = i18n.createMessageInstanceIdFn(__filename, UIStrings);
Expand Down
Expand Up @@ -35,7 +35,7 @@ const UIStrings = {
/** Description of a Lighthouse audit that tells the user *why* they should reduce or remove network resources that block the initial render of the page. 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: 'Resources are blocking the first paint of your page. Consider ' +
'delivering critical JS/CSS inline and deferring all non-critical ' +
'JS/styles. [Learn more](https://developers.google.com/web/tools/lighthouse/audits/blocking-resources).',
'JS/styles. [Learn more](https://web.dev/render-blocking-resources).',
};

const str_ = i18n.createMessageInstanceIdFn(__filename, UIStrings);
Expand Down
Expand Up @@ -18,7 +18,7 @@ const UIStrings = {
description:
'Large network payloads cost users real money and are highly correlated with ' +
'long load times. [Learn ' +
'more](https://developers.google.com/web/tools/lighthouse/audits/network-payloads).',
'more](https://web.dev/total-byte-weight).',
/** Used to summarize the total byte size of the page and all its network requests. The `{totalBytes}` placeholder will be replaced with the total byte sizes, shown in kilobytes (e.g. 142 KB) */
displayValue: 'Total size was {totalBytes, number, bytes}\xa0KB',
};
Expand Down
2 changes: 1 addition & 1 deletion lighthouse-core/audits/byte-efficiency/unminified-css.js
Expand Up @@ -15,7 +15,7 @@ const UIStrings = {
title: 'Minify CSS',
/** Description of a Lighthouse audit that tells the user *why* they should minify (remove whitespace) the page's CSS code. 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: 'Minifying CSS files can reduce network payload sizes. ' +
'[Learn more](https://developers.google.com/web/tools/lighthouse/audits/minify-css).',
'[Learn more](https://web.dev/unminified-css).',
};

const str_ = i18n.createMessageInstanceIdFn(__filename, UIStrings);
Expand Down
Expand Up @@ -14,7 +14,7 @@ const UIStrings = {
title: 'Minify JavaScript',
/** Description of a Lighthouse audit that tells the user *why* they should minify the page’s JS code to reduce file size. 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: 'Minifying JavaScript files can reduce payload sizes and script parse time. ' +
'[Learn more](https://developers.google.com/speed/docs/insights/MinifyResources).',
'[Learn more](https://web.dev/unminified-javascript).',
};

const str_ = i18n.createMessageInstanceIdFn(__filename, UIStrings);
Expand Down
2 changes: 1 addition & 1 deletion lighthouse-core/audits/byte-efficiency/unused-css-rules.js
Expand Up @@ -14,7 +14,7 @@ const UIStrings = {
/** Description of a Lighthouse audit that tells the user *why* they should defer loading any content in CSS that isn’t needed at page load. This is displayed after a user expands the section to see more. No word length limits. 'Learn More' becomes link text to additional documentation. */
description: 'Remove dead rules from stylesheets and defer the loading of CSS not used for ' +
'above-the-fold content to reduce unnecessary bytes consumed by network activity. ' +
'[Learn more](https://developers.google.com/web/tools/lighthouse/audits/unused-css).',
'[Learn more](https://web.dev/unused-css-rules).',
};

const str_ = i18n.createMessageInstanceIdFn(__filename, UIStrings);
Expand Down
Expand Up @@ -22,7 +22,7 @@ const UIStrings = {
/** Description of a Lighthouse audit that tells the user *why* they need to adopt a long cache lifetime policy. 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:
'A long cache lifetime can speed up repeat visits to your page. ' +
'[Learn more](https://developers.google.com/web/tools/lighthouse/audits/cache-policy).',
'[Learn more](https://web.dev/uses-long-cache-ttl).',
/** [ICU Syntax] Label for the audit identifying network resources with inefficient cache values. Clicking this will expand the audit to show the resources. */
displayValue: `{itemCount, plural,
=1 {1 resource found}
Expand Down
Expand Up @@ -18,7 +18,7 @@ const UIStrings = {
title: 'Efficiently encode images',
/** Description of a Lighthouse audit that tells the user *why* they need to efficiently encode images. 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: 'Optimized images load faster and consume less cellular data. ' +
'[Learn more](https://developers.google.com/web/tools/lighthouse/audits/optimize-images).',
'[Learn more](https://web.dev/uses-optimized-images).',
};

const str_ = i18n.createMessageInstanceIdFn(__filename, UIStrings);
Expand Down
Expand Up @@ -25,7 +25,7 @@ const UIStrings = {
description:
'Serve images that are appropriately-sized to save cellular data ' +
'and improve load time. ' +
'[Learn more](https://developers.google.com/web/tools/lighthouse/audits/oversized-images).',
'[Learn more](https://web.dev/uses-responsive-images).',
};

const str_ = i18n.createMessageInstanceIdFn(__filename, UIStrings);
Expand Down
Expand Up @@ -19,7 +19,7 @@ const UIStrings = {
/** Description of a Lighthouse audit that tells the user *why* their text-based resources should be served with compression (like gzip). 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: 'Text-based resources should be served with compression (gzip, deflate or' +
' brotli) to minimize total network bytes.' +
' [Learn more](https://developers.google.com/web/tools/lighthouse/audits/text-compression).',
' [Learn more](https://web.dev/uses-text-compression).',
};

const str_ = i18n.createMessageInstanceIdFn(__filename, UIStrings);
Expand Down
2 changes: 1 addition & 1 deletion lighthouse-core/audits/byte-efficiency/uses-webp-images.js
Expand Up @@ -18,7 +18,7 @@ const UIStrings = {
/** Description of a Lighthouse audit that tells the user *why* they should use newer and more efficient image formats. 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: 'Image formats like JPEG 2000, JPEG XR, and WebP often provide better ' +
'compression than PNG or JPEG, which means faster downloads and less data consumption. ' +
'[Learn more](https://developers.google.com/web/tools/lighthouse/audits/webp).',
'[Learn more](https://web.dev/uses-webp-images).',
};

const str_ = i18n.createMessageInstanceIdFn(__filename, UIStrings);
Expand Down
2 changes: 1 addition & 1 deletion lighthouse-core/audits/critical-request-chains.js
Expand Up @@ -17,7 +17,7 @@ const UIStrings = {
'loaded with a high priority. Consider reducing ' +
'the length of chains, reducing the download size of resources, or ' +
'deferring the download of unnecessary resources to improve page load. ' +
'[Learn more](https://developers.google.com/web/tools/lighthouse/audits/critical-request-chains).',
'[Learn more](https://web.dev/critical-request-chains).',
/** [ICU Syntax] Label for an audit identifying the number of sequences of dependent network requests used to load the page. */
displayValue: `{itemCount, plural,
=1 {1 chain found}
Expand Down
2 changes: 1 addition & 1 deletion lighthouse-core/audits/font-display.js
Expand Up @@ -23,7 +23,7 @@ const UIStrings = {
description:
'Leverage the font-display CSS feature to ensure text is user-visible while ' +
'webfonts are loading. ' +
'[Learn more](https://developers.google.com/web/updates/2016/02/font-display).',
'[Learn more](https://web.dev/font-display).',
/**
* @description A warning message that is shown when Lighthouse couldn't automatically check some of the page's fonts and that the user will need to manually check it.
* @example {https://font.cdn.com/} fontURL
Expand Down
3 changes: 2 additions & 1 deletion lighthouse-core/audits/mainthread-work-breakdown.js
Expand Up @@ -22,7 +22,8 @@ const UIStrings = {
failureTitle: 'Minimize main-thread work',
/** Description of a Lighthouse audit that tells the user *why* they should reduce JS execution times. 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: 'Consider reducing the time spent parsing, compiling and executing JS. ' +
'You may find delivering smaller JS payloads helps with this.',
'You may find delivering smaller JS payloads helps with this. ' +
'[Learn more](https://web.dev/mainthread-work-breakdown)',
/** Label for the Main Thread Category column in data tables, rows will have a main thread Category and main thread Task Name. */
columnCategory: 'Category',
};
Expand Down
2 changes: 1 addition & 1 deletion lighthouse-core/audits/metrics/estimated-input-latency.js
Expand Up @@ -16,7 +16,7 @@ const UIStrings = {
description: 'Estimated Input Latency is an estimate of how long your app takes to respond to ' +
'user input, in milliseconds, during the busiest 5s window of page load. If your ' +
'latency is higher than 50 ms, users may perceive your app as laggy. ' +
'[Learn more](https://developers.google.com/web/tools/lighthouse/audits/estimated-input-latency).',
'[Learn more](https://web.dev/estimated-input-latency).',
};

const str_ = i18n.createMessageInstanceIdFn(__filename, UIStrings);
Expand Down
2 changes: 1 addition & 1 deletion lighthouse-core/audits/metrics/first-contentful-paint.js
Expand Up @@ -14,7 +14,7 @@ const UIStrings = {
title: 'First Contentful Paint',
/** Description of the First Contentful Paint (FCP) metric, which marks the time at which the first text or image is painted by the browser. This is displayed within a tooltip when the user hovers on the metric name to see more. No character length limits. 'Learn More' becomes link text to additional documentation. */
description: 'First Contentful Paint marks the time at which the first text or image is ' +
`painted. [Learn more](https://developers.google.com/web/tools/lighthouse/audits/first-contentful-paint).`,
`painted. [Learn more](https://web.dev/first-contentful-paint).`,
};

const str_ = i18n.createMessageInstanceIdFn(__filename, UIStrings);
Expand Down
3 changes: 1 addition & 2 deletions lighthouse-core/audits/metrics/first-cpu-idle.js
Expand Up @@ -14,8 +14,7 @@ const UIStrings = {
title: 'First CPU Idle',
/** Description of the First CPU Idle metric, which marks the time at which the page has displayed content and the CPU is not busy executing the page's scripts. This is displayed within a tooltip when the user hovers on the metric name to see more. No character length limits. 'Learn More' becomes link text to additional documentation. */
description: 'First CPU Idle marks the first time at which the page\'s main thread is ' +
'quiet enough to handle input. ' +
'[Learn more](https://developers.google.com/web/tools/lighthouse/audits/first-interactive).',
'quiet enough to handle input. [Learn more](https://web.dev/first-cpu-idle).',
};

const str_ = i18n.createMessageInstanceIdFn(__filename, UIStrings);
Expand Down
2 changes: 1 addition & 1 deletion lighthouse-core/audits/metrics/first-meaningful-paint.js
Expand Up @@ -14,7 +14,7 @@ const UIStrings = {
title: 'First Meaningful Paint',
/** Description of the First Meaningful Paint (FMP) metric, which marks the time at which a majority of the content has been painted by the browser. This is displayed within a tooltip when the user hovers on the metric name to see more. No character length limits. 'Learn More' becomes link text to additional documentation. */
description: 'First Meaningful Paint measures when the primary content of a page is ' +
'visible. [Learn more](https://developers.google.com/web/tools/lighthouse/audits/first-meaningful-paint).',
'visible. [Learn more](https://web.dev/first-meaningful-paint).',
};

const str_ = i18n.createMessageInstanceIdFn(__filename, UIStrings);
Expand Down
2 changes: 1 addition & 1 deletion lighthouse-core/audits/metrics/interactive.js
Expand Up @@ -14,7 +14,7 @@ const UIStrings = {
title: 'Time to Interactive',
/** Description of the Time to Interactive (TTI) metric, which evaluates when a page has completed its primary network activity and main thread work. This is displayed within a tooltip when the user hovers on the metric name to see more. No character length limits. 'Learn More' becomes link text to additional documentation. */
description: 'Time to interactive is the amount of time it takes for the page to become fully ' +
'interactive. [Learn more](https://developers.google.com/web/tools/lighthouse/audits/consistently-interactive).',
'interactive. [Learn more](https://web.dev/interactive).',
};

const str_ = i18n.createMessageInstanceIdFn(__filename, UIStrings);
Expand Down
2 changes: 1 addition & 1 deletion lighthouse-core/audits/metrics/speed-index.js
Expand Up @@ -14,7 +14,7 @@ const UIStrings = {
title: 'Speed Index',
/** Description of the Speed Index metric, which summarizes how quickly the page looked visually complete. This is displayed within a tooltip when the user hovers on the metric name to see more. No character length limits. 'Learn More' becomes link text to additional documentation. */
description: 'Speed Index shows how quickly the contents of a page are visibly populated. ' +
'[Learn more](https://developers.google.com/web/tools/lighthouse/audits/speed-index).',
'[Learn more](https://web.dev/speed-index).',
};

const str_ = i18n.createMessageInstanceIdFn(__filename, UIStrings);
Expand Down
2 changes: 1 addition & 1 deletion lighthouse-core/audits/redirects.js
Expand Up @@ -17,7 +17,7 @@ const UIStrings = {
/** Imperative title of a Lighthouse audit that tells the user to eliminate the redirects taken through multiple URLs to load the page. This is shown in a list of audits that Lighthouse generates. */
title: 'Avoid multiple page redirects',
/** Description of a Lighthouse audit that tells users why they should reduce the number of server-side redirects on their page. 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: 'Redirects introduce additional delays before the page can be loaded. [Learn more](https://developers.google.com/web/tools/lighthouse/audits/redirects).',
description: 'Redirects introduce additional delays before the page can be loaded. [Learn more](https://web.dev/redirects).',
};

const str_ = i18n.createMessageInstanceIdFn(__filename, UIStrings);
Expand Down
2 changes: 1 addition & 1 deletion lighthouse-core/audits/time-to-first-byte.js
Expand Up @@ -16,7 +16,7 @@ const UIStrings = {
failureTitle: 'Reduce server response times (TTFB)',
/** Description of a Lighthouse audit that tells the user *why* they should reduce the amount of time it takes their server to start responding to requests. 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: 'Time To First Byte identifies the time at which your server sends a response.' +
' [Learn more](https://developers.google.com/web/tools/lighthouse/audits/ttfb).',
' [Learn more](https://web.dev/time-to-first-byte).',
/** Used to summarize the total Time to First Byte duration for the primary HTML response. The `{timeInMs}` placeholder will be replaced with the time duration, shown in milliseconds (e.g. 210 ms) */
displayValue: `Root document took {timeInMs, number, milliseconds}\xa0ms`,
};
Expand Down
2 changes: 1 addition & 1 deletion lighthouse-core/audits/user-timings.js
Expand Up @@ -15,7 +15,7 @@ const UIStrings = {
/** Description of a Lighthouse audit that tells the user they may want to use the User Timing API to help measure the performance of aspects of their page load and interaction. 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: 'Consider instrumenting your app with the User Timing API to measure your ' +
'app\'s real-world performance during key user experiences. ' +
'[Learn more](https://developers.google.com/web/tools/lighthouse/audits/user-timing).',
'[Learn more](https://web.dev/user-timings).',
/** [ICU Syntax] Label for an audit identifying the number of User Timing timestamps present in the page. */
displayValue: `{itemCount, plural,
=1 {1 user timing}
Expand Down
2 changes: 1 addition & 1 deletion lighthouse-core/audits/uses-rel-preconnect.js
Expand Up @@ -28,7 +28,7 @@ const UIStrings = {
/** Description of a Lighthouse audit that tells the user how to connect early to third-party domains that will be used to load page resources. 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:
'Consider adding `preconnect` or `dns-prefetch` resource hints to establish early ' +
`connections to important third-party origins. [Learn more](https://developers.google.com/web/fundamentals/performance/resource-prioritization#preconnect).`,
`connections to important third-party origins. [Learn more](https://web.dev/uses-rel-preconnect).`,
/**
* @description A warning message that is shown when the user tried to follow the advice of the audit, but it's not working as expected. Forgetting to set the `crossorigin` HTML attribute, or setting it to an incorrect value, on the link is a common mistake when adding preconnect links.
* @example {https://example.com} securityOrigin
Expand Down
2 changes: 1 addition & 1 deletion lighthouse-core/audits/uses-rel-preload.js
Expand Up @@ -19,7 +19,7 @@ const UIStrings = {
title: 'Preload key requests',
/** Description of a Lighthouse audit that tells the user *why* they should preload important network requests. The associated network requests are started halfway through pageload (or later) but should be started at the beginning. This is displayed after a user expands the section to see more. No character length limits. '<link rel=preload>' is the html code the user would include in their page and shouldn't be translated. 'Learn More' becomes link text to additional documentation. */
description: 'Consider using `<link rel=preload>` to prioritize fetching resources that are ' +
'currently requested later in page load. [Learn more](https://developers.google.com/web/tools/lighthouse/audits/preload).',
'currently requested later in page load. [Learn more](https://web.dev/uses-rel-preload).',
/**
* @description A warning message that is shown when the user tried to follow the advice of the audit, but it's not working as expected. Forgetting to set the `crossorigin` HTML attribute, or setting it to an incorrect value, on the link is a common mistake when adding preload links.
* @example {https://example.com} preloadURL
Expand Down

0 comments on commit da334b8

Please sign in to comment.