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

Remove or refactor duplicate content in HTML artices in Learn area #33046

Open
dipikabh opened this issue Apr 11, 2024 · 5 comments
Open

Remove or refactor duplicate content in HTML artices in Learn area #33046

dipikabh opened this issue Apr 11, 2024 · 5 comments
Labels
Content:Learn:HTML Learning area HTML docs Content:Learn Learning area docs needs decision The task needs consensus through discussion

Comments

@dipikabh
Copy link
Contributor

MDN URL

https://developer.mozilla.org/en-US/docs/Learn/Getting_started_with_the_web/HTML_basics

What specific section or headline is this issue about?

https://developer.mozilla.org/en-US/docs/Learn/Getting_started_with_the_web/HTML_basics#anatomy_of_an_html_element

What information was incorrect, unhelpful, or incomplete?

This issue has been raised in https://github.com/orgs/mdn/discussions/658.

Some of the sections and content across these two pages is duplicate or very similar:
https://developer.mozilla.org/en-US/docs/Learn/Getting_started_with_the_web/HTML_basics
https://developer.mozilla.org/en-US/docs/Learn/HTML/Introduction_to_HTML/Getting_started

For example:

What did you expect to see?

Content that is not dupliacte

Do you have any supporting links, references, or citations?

No response

Do you have anything more you want to share?

No response

@dipikabh dipikabh added the needs triage Triage needed by staff and/or partners. Automatically applied when an issue is opened. label Apr 11, 2024
@github-actions github-actions bot added Content:Learn Learning area docs Content:Learn:HTML Learning area HTML docs labels Apr 11, 2024
@awxiaoxian2020
Copy link
Contributor

Any experts want to put forward for this? ping politely @bsmth and @wbamberg to get some good ideas :)

@wbamberg
Copy link
Collaborator

wbamberg commented May 30, 2024

I'm not sure what's best here, and wonder what @chrisdavidmills thinks. Yes, a fair amount of https://developer.mozilla.org/en-US/docs/Learn/Getting_started_with_the_web/HTML_basics#so_what_is_html is duplicated from https://developer.mozilla.org/en-US/docs/Learn/HTML/Introduction_to_HTML/Getting_started, although there are more or less editorial divergences.

And yes, duplication in general is not great. But these pages serve different audiences.

  • "Getting started with the web" is a crash course in the absolute basics of front-end, including HTML, CSS, JS, and tooling.
  • "Getting started with HTML" is the first chapter in a more elaborate and advanced HTML course.

Both chapters need to talk about, for instance, the anatomy of an HTML element, but they don't at all share the same flow, so trying to de-dupe the content is likely to make the content less useful for people following one or the other course.

So I'm inclined to think that the duplication is the best option at the moment, and we should close this issue..

@awxiaoxian2020
Copy link
Contributor

I agree that they don't at all share the same flow. if we de-dupe the content, we need more efforts. But I think we should design a new pattern or mode or structure for these content. It just give readers a good experience :)

@Josh-Cena
Copy link
Member

I also agree that very little can be done. Realistically speaking it's a small duplication. And it just serves as a natural segue into talking about other things like attributes and elements. If you replace either occurrence with "See the other page for an anatomy of the element", you will just make everything else appear out of context.

@Josh-Cena Josh-Cena added needs decision The task needs consensus through discussion and removed needs triage Triage needed by staff and/or partners. Automatically applied when an issue is opened. labels Jun 10, 2024
@awxiaoxian2020
Copy link
Contributor

My vision is to completely restructure these contents rather than just doing some simple removals to provide beginners with a good experience. The beginners around me are all confused about why the previously introduced content appears again. At the very least, we need an explanation to introduce the relationships between these contents.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Content:Learn:HTML Learning area HTML docs Content:Learn Learning area docs needs decision The task needs consensus through discussion
Projects
None yet
Development

No branches or pull requests

4 participants