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

core(audits): Point best practices audit links to web.dev #9538

Merged
merged 1 commit into from
Aug 13, 2019
Merged

core(audits): Point best practices audit links to web.dev #9538

merged 1 commit into from
Aug 13, 2019

Conversation

mfriesenhahn
Copy link
Collaborator

Summary

  • Point "Learn more" links in best practices audits to relevant web.dev guides.
  • Change last sentence in Specifying a doctype prevents the browser audit description from "Read more on the MDN Web Docs page" to "Learn more".
  • Add "Learn more" link to Detected JS libraries audit.
  • Add "Learn more" link to Errors logged to the console indicate unresolved problems audit.

Copy link
Collaborator

@patrickhulce patrickhulce left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@@ -15,8 +15,8 @@ const UIStrings = {
failureTitle: 'Page lacks the HTML doctype, thus triggering quirks-mode',
/** Description of a Lighthouse audit that tells the user why they should define an HTML doctype. 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 doctype prevents the browser ' +
'from switching to quirks-mode. Read more on the ' +
'[MDN Web Docs page](https://developer.mozilla.org/en-US/docs/Glossary/Doctype)',
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

man we're really not making good progress on getting rid of Learn more are we team 😆

(I think this is the right thing to do here @mfriesenhahn, just a bummer that we've been talking about following our own advice for a long time and it's sad to see one more convert to "Learn more")

@@ -17,7 +17,7 @@ const UIStrings = {
/** Description of a Lighthouse audit that tells the user why and how they should secure cross-origin links. 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 `rel="noopener"` or `rel="noreferrer"` to any external links to improve ' +
'performance and prevent security vulnerabilities. ' +
'[Learn more](https://developers.google.com/web/tools/lighthouse/audits/noopener).',
'[Learn more](https://web.dev/external-anchors-use-rel-noopener).',
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

FWIW this doc just came up in #9531 about possibly needing some tweaks

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've added this comment to web.dev issue 1342 for tracking.

Copy link
Member

@exterkamp exterkamp left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👁️ ✔️

'from switching to quirks-mode. Read more on the ' +
'[MDN Web Docs page](https://developer.mozilla.org/en-US/docs/Glossary/Doctype)',
'from switching to quirks-mode. ' +
'[Learn more](https://web.dev/doctype).',
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This can probably fit with the line above.

@@ -31,7 +31,7 @@ const UIStrings = {
`depth < ${MAX_DOM_TREE_DEPTH} elements and fewer than ${MAX_DOM_TREE_WIDTH} ` +
'children/parent element. A large DOM can increase memory usage, cause longer ' +
'[style calculations](https://developers.google.com/web/fundamentals/performance/rendering/reduce-the-scope-and-complexity-of-style-calculations), ' +
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just curious if style calculations and layout reflows will be replaced sometime?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Probably! 😄

@addyosmani can probably give a better sense of the priority of those docs relative to other stuff in the perf section.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants