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

Experiment with adding/updating Scrimba links #38488

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

chrisdavidmills
Copy link
Contributor

Description

This PR updates several Learn web development pages to add and/or modify the position of Scrimba learning partner affiliate links. The aim here is to make them more effective, more useful for our readers, and not feel too overwhelming or spammy.

Motivation

Additional details

Related issues and pull requests

@chrisdavidmills chrisdavidmills requested a review from a team as a code owner March 6, 2025 13:09
@chrisdavidmills chrisdavidmills requested review from hamishwillee and removed request for a team March 6, 2025 13:09
@chrisdavidmills chrisdavidmills marked this pull request as draft March 6, 2025 13:09
@github-actions github-actions bot added Content:Learn Learning area docs size/m [PR only] 51-500 LoC changed labels Mar 6, 2025
Copy link
Contributor

github-actions bot commented Mar 6, 2025

Preview URLs (14 pages)
Flaws (25)

Note! 7 documents with no flaws that don't need to be listed. 🎉

URL: /en-US/docs/Learn_web_development
Title: Learn web development
Flaw count: 1

  • unknown:
    • No generic content config found

URL: /en-US/docs/Learn_web_development/Getting_started/Your_first_website/Creating_the_content
Title: HTML: Creating the content
Flaw count: 8

  • broken_links:
    • /en-US/docs/Glossary/element is ill cased
    • /en-US/docs/Glossary/tag is ill cased
    • /en-US/docs/Glossary/void_element is ill cased
    • /en-US/docs/Glossary/keyword is ill cased
  • macros:
    • Macro produces link /en-US/docs/Glossary/element which is a redirect
    • Macro produces link /en-US/docs/Glossary/tag which is a redirect
    • Macro produces link /en-US/docs/Glossary/void_element which is a redirect
    • Macro produces link /en-US/docs/Glossary/keyword which is a redirect

URL: /en-US/docs/Learn_web_development/Getting_started/Your_first_website/Adding_interactivity
Title: JavaScript: Adding interactivity
Flaw count: 2

  • broken_links:
    • /en-US/docs/Glossary/operator is ill cased
  • macros:
    • Macro produces link /en-US/docs/Glossary/operator which is a redirect

URL: /en-US/docs/Learn_web_development/Core/Scripting/Arrays
Title: Arrays
Flaw count: 2

  • broken_links:
    • /en-US/docs/Web/JavaScript/Reference/statements/for...of is ill cased
  • macros:
    • Macro produces link /en-US/docs/Web/JavaScript/Reference/statements/for...of which is a redirect

URL: /en-US/docs/Learn_web_development/Core/Scripting/Variables
Title: Storing the information you need — Variables
Flaw count: 2

  • broken_links:
    • /en-US/docs/Glossary/camel_case is ill cased
  • macros:
    • Macro produces link /en-US/docs/Glossary/camel_case which is a redirect

URL: /en-US/docs/Learn_web_development/Core/Structuring_content/Basic_HTML_syntax
Title: Basic HTML syntax
Flaw count: 6

  • broken_links:
    • /en-US/docs/Glossary/void_element is ill cased
    • /en-US/docs/Glossary/character_reference is ill cased
    • /en-US/docs/Glossary/character_reference is ill cased
  • macros:
    • Macro produces link /en-US/docs/Glossary/void_element which is a redirect
    • Macro produces link /en-US/docs/Glossary/character_reference which is a redirect
    • Macro produces link /en-US/docs/Glossary/character_reference which is a redirect

URL: /en-US/docs/Learn_web_development/Core/Styling_basics/What_is_CSS
Title: What is CSS?
Flaw count: 4

  • broken_links:
    • /en-US/docs/Glossary/browser is ill cased
    • /en-US/docs/Glossary/property/CSS is ill cased
  • macros:
    • Macro produces link /en-US/docs/Glossary/browser which is a redirect
    • Macro produces link /en-US/docs/Glossary/property/CSS which is a redirect
External URLs (22)

URL: /en-US/docs/Learn_web_development
Title: Learn web development


URL: /en-US/docs/Learn_web_development/Getting_started
Title: Getting started modules


URL: /en-US/docs/Learn_web_development/Getting_started/Your_first_website/Creating_the_content
Title: HTML: Creating the content


URL: /en-US/docs/Learn_web_development/Getting_started/Your_first_website/Styling_the_content
Title: CSS: Styling the content


URL: /en-US/docs/Learn_web_development/Getting_started/Your_first_website/Adding_interactivity
Title: JavaScript: Adding interactivity


URL: /en-US/docs/Learn_web_development/Getting_started/Your_first_website/Publishing_your_website
Title: Publishing your website


URL: /en-US/docs/Learn_web_development/Core/Text_styling/Fundamentals
Title: Fundamental text and font styling


URL: /en-US/docs/Learn_web_development/Core/Scripting/Arrays
Title: Arrays


URL: /en-US/docs/Learn_web_development/Core/Scripting/What_is_JavaScript
Title: What is JavaScript?


URL: /en-US/docs/Learn_web_development/Core/Scripting/Variables
Title: Storing the information you need — Variables


URL: /en-US/docs/Learn_web_development/Core/Structuring_content
Title: Structuring content with HTML


URL: /en-US/docs/Learn_web_development/Core/Structuring_content/Basic_HTML_syntax
Title: Basic HTML syntax


URL: /en-US/docs/Learn_web_development/Core/CSS_layout/Flexbox
Title: Flexbox


URL: /en-US/docs/Learn_web_development/Core/Styling_basics/What_is_CSS
Title: What is CSS?

(comment last updated: 2025-03-11 09:45:29)

@hamishwillee
Copy link
Collaborator

@chrisdavidmills I'm not going to properly review this until it gets out of draft. The links seem to be a reasonable integration in the right places. They are definitely not overwhelming.

This is the first time we've had preferential addition of links based on some kind of commercial affiliation rather than technical merit. That makes me uncomfortable, in part because what do we do when someone else comes along and PRs in their link in the same places but doesn't want to pay - according to MDN rules we then we have this whole argument about maintenance lists etc.

Anyway, assuming their content is good, this is reasonable. Alternative is something like a clearly differentiated section for affiliate links.

Copy link
Contributor

This pull request has merge conflicts that must be resolved before it can be merged.

@github-actions github-actions bot added the merge conflicts 🚧 [PR only] label Mar 11, 2025
@github-actions github-actions bot removed the merge conflicts 🚧 [PR only] label Mar 11, 2025
@chrisdavidmills
Copy link
Contributor Author

@chrisdavidmills I'm not going to properly review this until it gets out of draft. The links seem to be a reasonable integration in the right places. They are definitely not overwhelming.

Cool, that's good to hear. The priority for these links is that they are useful, provide an alternative way of consuming some of the information we provide on learn, and are not spammy or annoying.

This is the first time we've had preferential addition of links based on some kind of commercial affiliation rather than technical merit. That makes me uncomfortable, in part because what do we do when someone else comes along and PRs in their link in the same places but doesn't want to pay - according to MDN rules we then we have this whole argument about maintenance lists etc.

We deliberately published new guidelines to try to tackle this issue — https://developer.mozilla.org/en-US/docs/MDN/Writing_guidelines/Learning_content#external_links_and_embeds

I'd be interested in your thoughts on whether these adequately address the problem, or if we need to make updates. I suspect some of my changes here have not followed the ""See also" link order" section guidance, which is my fault.

Anyway, assuming their content is good, this is reasonable. Alternative is something like a clearly differentiated section for affiliate links.

@hamishwillee
Copy link
Collaborator

hamishwillee commented Mar 13, 2025

Thanks for the comments.

  1. I'll review this again in the context of https://developer.mozilla.org/en-US/docs/MDN/Writing_guidelines/Learning_content#external_links_and_embeds once you move it out of draft. There are a few cases where there is no alternative to the Scrimba link.
  2. I think that <sup>_MDN learning partner_</sup> should be a link to either these guidelines or (probably better) a section on affiliate partners that then links to these guidelines. That will pre-empt the questions and also make it clear why and how this has been done.

EDIT PS - I do like the updates to the guildelines above - they make it pretty clear that we're aware of the sensitivities.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Content:Learn Learning area docs size/m [PR only] 51-500 LoC changed
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants