Skip to content

Commit

Permalink
core(audits): point PWA audit description links to web.dev (#9539)
Browse files Browse the repository at this point in the history
  • Loading branch information
mfriesenhahn authored and brendankenny committed Aug 24, 2019
1 parent 9c2eeac commit a1e05d6
Show file tree
Hide file tree
Showing 18 changed files with 70 additions and 71 deletions.
2 changes: 1 addition & 1 deletion lighthouse-core/audits/content-width.js
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ const UIStrings = {
/** Description of a Lighthouse audit that tells the user why they should care that a site's content size should match its viewport size, which is the size of the screen the site is displayed on. 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: 'If the width of your app\'s content doesn\'t match the width ' +
'of the viewport, your app might not be optimized for mobile screens. ' +
'[Learn more](https://developers.google.com/web/tools/lighthouse/audits/content-sized-correctly-for-viewport).',
'[Learn more](https://web.dev/content-width).',
/**
* @description Explanatory message stating that the viewport size and window size differ.
* @example {100} innerWidth
Expand Down
2 changes: 1 addition & 1 deletion lighthouse-core/audits/installable-manifest.js
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ const UIStrings = {
/** Description of a Lighthouse audit that tells the user why installability is important for webapps. 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: 'Browsers can proactively prompt users to add your app to their homescreen, ' +
'which can lead to higher engagement. ' +
'[Learn more](https://developers.google.com/web/tools/lighthouse/audits/install-prompt).',
'[Learn more](https://web.dev/installable-manifest).',
};

const str_ = i18n.createMessageInstanceIdFn(__filename, UIStrings);
Expand Down
2 changes: 1 addition & 1 deletion lighthouse-core/audits/load-fast-enough-for-pwa.js
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ const UIStrings = {
/** Imperative title of a Lighthouse audit that tells the user that their page has loaded fast enough to be considered a Progressive Web App. This imperative title is shown to users when the web page has loaded too slowly to be considered a Progressive Web App. */
failureTitle: 'Page load is not fast enough on mobile networks',
/** Description of a Lighthouse audit that tells the user *why* they need to load fast enough on mobile networks. 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 fast page load over a cellular network ensures a good mobile user experience. [Learn more](https://developers.google.com/web/tools/lighthouse/audits/fast-3g).',
description: 'A fast page load over a cellular network ensures a good mobile user experience. [Learn more](https://web.dev/load-fast-enough-for-pwa).',
/** Label for the audit identifying the time it took for the page to become interactive. */
displayValueText: 'Interactive at {timeInMs, number, seconds}\xa0s',
/** Label for the audit identifying the time it took for the page to become interactive on a mobile network. */
Expand Down
2 changes: 1 addition & 1 deletion lighthouse-core/audits/manual/pwa-cross-browser.js
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ const UIStrings = {
title: 'Site works cross-browser',
/** Description of a Lighthouse audit that tells the user why they should make sites work across different browsers. 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: 'To reach the most number of users, sites should work across ' +
'every major browser. [Learn more](https://developers.google.com/web/progressive-web-apps/checklist#site-works-cross-browser).',
'every major browser. [Learn more](https://web.dev/pwa-cross-browser).',
};

const str_ = i18n.createMessageInstanceIdFn(__filename, UIStrings);
Expand Down
2 changes: 1 addition & 1 deletion lighthouse-core/audits/manual/pwa-each-page-has-url.js
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ const UIStrings = {
title: 'Each page has a URL',
/** Description of a Lighthouse audit that tells the user why they should use unique URLs for each web 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: 'Ensure individual pages are deep linkable via URL and that URLs are ' +
'unique for the purpose of shareability on social media. [Learn more](https://developers.google.com/web/progressive-web-apps/checklist#each-page-has-a-url).',
'unique for the purpose of shareability on social media. [Learn more](https://web.dev/pwa-each-page-has-url).',
};

const str_ = i18n.createMessageInstanceIdFn(__filename, UIStrings);
Expand Down
2 changes: 1 addition & 1 deletion lighthouse-core/audits/manual/pwa-page-transitions.js
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ const UIStrings = {
title: 'Page transitions don\'t feel like they block on the network',
/** Description of a Lighthouse audit that tells the user why they should make transitions in their web app feel fast. 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: 'Transitions should feel snappy as you tap around, even on a slow network, a ' +
'key to perceived performance. [Learn more](https://developers.google.com/web/progressive-web-apps/checklist#page-transitions-dont-feel-like-they-block-on-the-network).',
'key to perceived performance. [Learn more](https://web.dev/pwa-page-transitions).',
};

const str_ = i18n.createMessageInstanceIdFn(__filename, UIStrings);
Expand Down
2 changes: 1 addition & 1 deletion lighthouse-core/audits/offline-start-url.js
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ const UIStrings = {
failureTitle: '`start_url` does not respond with a 200 when offline',
/** Description of a Lighthouse audit that tells the user why a website should respond to requests when offline. 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 service worker enables your web app to be reliable in unpredictable ' +
'network conditions. [Learn more](https://developers.google.com/web/tools/lighthouse/audits/http-200-when-offline).',
'network conditions. [Learn more](https://web.dev/offline-start-url).',
/**
* @description Warning that the audit couldn't find the start_url and used the page's URL instead.
* @example {No Manifest Fetched.} manifestWarning
Expand Down
2 changes: 1 addition & 1 deletion lighthouse-core/audits/redirects-http.js
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ const UIStrings = {
failureTitle: 'Does not redirect HTTP traffic to HTTPS',
/** Description of a Lighthouse audit that tells the user why they should direct HTTP traffic to HTTPS. 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: 'If you\'ve already set up HTTPS, make sure that you redirect all HTTP ' +
'traffic to HTTPS in order to enable secure web features for all your users. [Learn more](https://developers.google.com/web/tools/lighthouse/audits/http-redirects-to-https).',
'traffic to HTTPS in order to enable secure web features for all your users. [Learn more](https://web.dev/redirects-http).',
};

const str_ = i18n.createMessageInstanceIdFn(__filename, UIStrings);
Expand Down
2 changes: 1 addition & 1 deletion lighthouse-core/audits/service-worker.js
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ const UIStrings = {
/** Description of a Lighthouse audit that tells the user why they should use a service worker. 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 service worker is the technology that enables your app to use many ' +
'Progressive Web App features, such as offline, add to homescreen, and push ' +
'notifications. [Learn more](https://developers.google.com/web/tools/lighthouse/audits/registered-service-worker).',
'notifications. [Learn more](https://web.dev/service-worker).',
/**
* @description Message explaining that the website may have service workers, but none are in scope to control the tested web page.
* @example {https://example.com/} pageUrl
Expand Down
2 changes: 1 addition & 1 deletion lighthouse-core/audits/splash-screen.js
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ const UIStrings = {
/** Description of a Lighthouse audit that tells the user why they should configure a custom splash screen. 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 themed splash screen ensures a high-quality experience when ' +
'users launch your app from their homescreens. [Learn ' +
'more](https://developers.google.com/web/tools/lighthouse/audits/custom-splash-screen).',
'more](https://web.dev/splash-screen).',
};

const str_ = i18n.createMessageInstanceIdFn(__filename, UIStrings);
Expand Down
2 changes: 1 addition & 1 deletion lighthouse-core/audits/themed-omnibox.js
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ const UIStrings = {
failureTitle: 'Does not set a theme color for the address bar.',
/** Description of a Lighthouse audit that tells the user why they should set a theme color for the browser's address bar. 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 browser address bar can be themed to match your site. ' +
'[Learn more](https://developers.google.com/web/tools/lighthouse/audits/address-bar).',
'[Learn more](https://web.dev/themed-omnibox).',
};

const str_ = i18n.createMessageInstanceIdFn(__filename, UIStrings);
Expand Down
3 changes: 1 addition & 2 deletions lighthouse-core/audits/viewport.js
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ const UIStrings = {
'or `initial-scale`',
/** Description of a Lighthouse audit that tells the user why they should have a viewport meta tag in their html. 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: 'Add a `<meta name="viewport">` tag to optimize your app for mobile screens. ' +
'[Learn more](https://developers.google.com/web/tools/lighthouse/audits/has-viewport-meta-tag).',
'[Learn more](https://web.dev/viewport).',
/** Explanatory message stating that no viewport meta tag exists on the page. */
explanationNoTag: 'No `<meta name="viewport">` tag found',
};
Expand Down Expand Up @@ -62,4 +62,3 @@ class Viewport extends Audit {

module.exports = Viewport;
module.exports.UIStrings = UIStrings;

2 changes: 1 addition & 1 deletion lighthouse-core/audits/without-javascript.js
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ const UIStrings = {
/** Description of a Lighthouse audit that tells the user why they should return content even if Javascript is unavailable in a browser. 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: 'Your app should display some content when JavaScript is disabled, even if ' +
'it\'s just a warning to the user that JavaScript is required to use the app. ' +
'[Learn more](https://developers.google.com/web/tools/lighthouse/audits/no-js).',
'[Learn more](https://web.dev/without-javascript).',
/** Message explaining that a website's body should render some (any) content even if the page's JavaScript cannot be loaded. */
explanation: 'The page body should render some content if its scripts are not available.',
};
Expand Down
2 changes: 1 addition & 1 deletion lighthouse-core/audits/works-offline.js
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ const UIStrings = {
/** Description of a Lighthouse audit that tells the user why a website should respond to requests when offline. 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: 'If you\'re building a Progressive Web App, consider using a service worker ' +
'so that your app can work offline. ' +
'[Learn more](https://developers.google.com/web/tools/lighthouse/audits/http-200-when-offline).',
'[Learn more](https://web.dev/works-offline).',
/**
* @description Warning that the web page redirected during testing and that may have affected the offline load test.
* @example {https://example.com/requested/page} requested
Expand Down
Loading

0 comments on commit a1e05d6

Please sign in to comment.