mdn / content

The content behind MDN Web Docs
https://developer.mozilla.org
Other
9.13k stars 22.45k forks source link

Decide what to do about 'Performance basics' #29240

Open wbamberg opened 11 months ago

wbamberg commented 11 months ago

MDN URL

https://developer.mozilla.org/en-US/docs/Learn/Performance/Web_Performance_Basics

What specific section or headline is this issue about?

All of it.

What information was incorrect, unhelpful, or incomplete?

This page lives inside the URL structure for the Learn/Performance module, but isn't properly integrated into the Learn/Performance IA:

Also though, its content does not make sense in the context of the Learn module as a whole. It consists of a collection of performance tips, some of which are covered in detail in other parts of the module, but it doesn't acknowledge any of those other parts.

The history here I think is that https://developer.mozilla.org/en-US/docs/Learn/Performance/Web_Performance_Basics was moved from https://developer.mozilla.org/en-US/docs/Web/Performance/ (in which it was outside the Learn module) into https://developer.mozilla.org/en-US/docs/Learn/Performance, but noone thought to update the nav or consider the content.

I think a real fix here would also address the question of why we have some perf guides at https://developer.mozilla.org/en-US/docs/Web/Performance/ and some at https://developer.mozilla.org/en-US/docs/Learn/Performance. Should we only have one place to teach web perf? If we want two, why, and what's a differentiating factor, and how can we make them work together?

What did you expect to see?

Coherent content and a consistent nav.

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

No response

Do you have anything more you want to share?

No response

caugner commented 11 months ago

@wbamberg Are you planning to work on this?

The way I see it:

  1. That page is missing in the sidebar (needs a yari PR).
  2. The PreviousMenu macro is missing at the bottom (needs a content PR).
wbamberg commented 11 months ago

The way I see it:

  1. That page is missing in the sidebar (needs a yari PR).

  2. The PreviousMenu macro is missing at the bottom (needs a content PR).

I don't think this alone would be a good fix. The underlying issue is that https://developer.mozilla.org/en-US/docs/Learn/Performance/Web_Performance_Basics doesn't make sense as the final page in the Performance Learn module, seeing as it is a collection of performance tips that doesn't acknowledge its existence as part of a wider series of articles, probably because it wasn't part of a series of articles when it was written.

So "Nav is broken in Learn/Performance article" is probably not a very good title for this, and maybe ""Decide what to do about 'Performance basics'" would be better. Maybe we should delete it, or keep it, rewrite it, and fix the nav.

Are you planning to work on this?

Not right now, but maybe eventually if noone else does. I think a proper fix is a lot of work though.

Rumyra commented 10 months ago

This sounds to me like more of a project suggestion than an issue - am I correct @wbamberg ? If so I can label accordingly and transfer into the roadmap backlog

wbamberg commented 10 months ago

This sounds to me like more of a project suggestion than an issue

What are the criteria for deciding that, and would it still be visible in this issue list? "transfer" makes it sound like it wouldn't.

Rumyra commented 10 months ago

There's guidelines here https://github.com/orgs/mdn/projects/26/views/7?pane=info - but re-reading it, it seems like we want to make this more of a guide rather than part of the learning area, and put it back with /Web/Performance (?)