Add learning area guidelines #37792
Draft
Add learning area guidelines #37792
+110
−0
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
chrisdavidmills
requested review from
hamishwillee
and removed request for
a team
|
Preview URLs
External URLs (1)URL:
|
chrisdavidmills
requested review from
hamishwillee
and removed request for
hamishwillee
That's fine mate. There is no reason you need to look at this one, although obviously, you can if you want to. I've tried removing you, but it has you stuck at the top of the reviewers list, even thought you are not checked. Really weird. |
estelle
reviewed
Jan 29, 2025
|
|
||
| - Won't add these links in a way that compromises the integrity of MDN's content and is openly spammy; only where we feel they are genuinely useful. | ||
| - Will always make sure a free option is available beside anything that is paywalled. In many cases, we've managed to convince our partners to make content available for free that was previously paywalled. | ||
| - Will clearly mark partner content with a "MDN Curriculum partner" label, so you can clearly tell them apart from other links. |
There was a problem hiding this comment.
the "learn web development (LWD)" area and "curriculum" are two separate areas of the site. Using curriculum on the LWD pages is a bit confusing.
Are they a partner or a sponsor? Curriculum, LWD, or both? Maybe we should go with "MDN sponsored link" ?
It would be helpful to have instructions here as to the order of links in a list of links:
- internal content,
- free content, with a note that partners should be listed first in this category, and must be identified as a sponsored link.
- mixed free/paywall content - again, noting partners should be listed first in this group and must be identified as a sponsored link.
And a note that we do not link to sites where all content is paywalled (and if this changes, sponsors first)
Rumyra
reviewed
Jan 30, 2025
| MDN Learn Web Development (also known as Learn)'s target audience is people who are not expert front-end developers — this includes students, junior or trainee web developers, hobbyists, and teachers looking for best practice guidance on what to teach their students. | ||
|
|
||
| > [!NOTE] | ||
| > We are avoiding using the word "beginner", as that term is subjective — for example, some beginners to web development may have previous programming experience in non-web languages and therefore may find certain topics easy, whereas others may find certain topics quite difficult. In addition, someone who has worked as a web designer professionally for many years might be an expert in HTML and CSS, but still be a beginner in JavaScript. |
There was a problem hiding this comment.
I avoid the term 'junior' for these reasons and use the term 'beginner' precisely for the last point in this sentence
Rumyra
requested changes
Jan 30, 2025
| > Try this... | ||
| ``` | ||
|
|
||
| - **Challenges**: Learn content includes challenges periodically to test that the reader understands the topics they have learnt about before moving on to the next article. These are currently written in a few different styles, for example see [Challenge: Structuring a page of content](/en-US/docs/Learn_web_development/Core/Structuring_content/Structuring_a_page_of_content) and [Test your skills: HTML images](/en-US/docs/Learn_web_development/Core/Structuring_content/HTML_images/Test_your_skills:_HTML_images), but we intend to improve the consistency and experience her in the future. |
There was a problem hiding this comment.
Suggested change
| - **Challenges**: Learn content includes challenges periodically to test that the reader understands the topics they have learnt about before moving on to the next article. These are currently written in a few different styles, for example see [Challenge: Structuring a page of content](/en-US/docs/Learn_web_development/Core/Structuring_content/Structuring_a_page_of_content) and [Test your skills: HTML images](/en-US/docs/Learn_web_development/Core/Structuring_content/HTML_images/Test_your_skills:_HTML_images), but we intend to improve the consistency and experience her in the future. | |
| - **Challenges**: Learn content includes challenges periodically to test that the reader understands the topics they have learnt about before moving on to the next article. These are currently written in a few different styles, for example see [Challenge: Structuring a page of content](/en-US/docs/Learn_web_development/Core/Structuring_content/Structuring_a_page_of_content) and [Test your skills: HTML images](/en-US/docs/Learn_web_development/Core/Structuring_content/HTML_images/Test_your_skills:_HTML_images), but we intend to improve the consistency and experience of these in the future. |
| - The fundamental technologies required at the start of a web developer's journey in our [Core modules](/en-US/docs/Learn_web_development/Core). | ||
| - "Second wave" topics representing useful next steps for relative beginners to move on to once they've mastered the Core modules, in our [Extensions modules](/en-US/docs/Learn_web_development/Extensions). | ||
|
|
||
| Learn is not intended to be the place on MDN for introductory content on _all_ topics. This means that niche topics such as MathML and Web Games, and advanced or specialist topics such as regular expressions, performance testing, WebRTC, and WebGPU, do not belong on Learn. |
There was a problem hiding this comment.
Suggested change
| Learn is not intended to be the place on MDN for introductory content on _all_ topics. This means that niche topics such as MathML and Web Games, and advanced or specialist topics such as regular expressions, performance testing, WebRTC, and WebGPU, do not belong on Learn. | |
| Learn is not intended to be the place on MDN for introductory content on _all_ topics. This means that niche topics such as MathML and Web Games, and advanced or specialist topics such as regular expressions, performance testing, WebRTC, and WebGPU, do not belong in Learn. |
|
|
||
| Learn is not intended to be the place on MDN for introductory content on _all_ topics. This means that niche topics such as MathML and Web Games, and advanced or specialist topics such as regular expressions, performance testing, WebRTC, and WebGPU, do not belong on Learn. | ||
|
|
||
| If you do not see a topic covered on Learn and you think it should be covered, don't just try to add it — discuss it with us first (see [Suggesting content](/en-US/docs/MDN/Writing_guidelines/What_we_write#suggesting_content)). |
There was a problem hiding this comment.
Suggested change
| If you do not see a topic covered on Learn and you think it should be covered, don't just try to add it — discuss it with us first (see [Suggesting content](/en-US/docs/MDN/Writing_guidelines/What_we_write#suggesting_content)). | |
| If you do not see a topic covered in Learn and you think it should be covered, don't just try to add it — discuss it with us first (see [Suggesting content](/en-US/docs/MDN/Writing_guidelines/What_we_write#suggesting_content)). |
|
This pull request has merge conflicts that must be resolved before it can be merged. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This PR is my first attempt at writing new guidelines to cover the updated Learn web development section, partner links, etc.
Motivation
Additional details
Related issues and pull requests