chore(http): delete "Basics of HTTP" page in favor of HTTP landing page, reorganize index #35774
Conversation
bsmth
requested review from
estelle,
hamishwillee,
pepelsbey and
wbamberg
and removed request for
a team
github-actions
bot
added
Content:HTML
|
This pull request has merge conflicts that must be resolved before it can be merged. |
|
@bsmth can we get this merged despite the Yari PR? We need to merge this beforehand anyway. |
Thanks for asking, coming back to it again, I believe it's safe to merge before the sidebars changes. The only oddity would be |
Josh-Cena
left a comment
Josh-Cena
left a comment
There was a problem hiding this comment.
I've always been confused about the HTTP doc structure, but approving so you can merge any time. But I think anything that's not listed in "references" and "security&privacy" sections actually looks like a "guide".
files/en-us/web/http/index.md
Outdated
| ## Practical and topical guides | ||
|
|
||
| ## Reference | ||
| Learn about common communication patterns and methods for improving security, resource usage and network efficiency. |
There was a problem hiding this comment.
FWIW, I don't really get what the difference between these and "concepts" are. For example "Content negotiation" is as guide-y as "HTTP caching" is to me.
There was a problem hiding this comment.
That's true, what helped me categorize them here at first is that the guides in the 'practical' section here are more 'how-to' (how to do caching, redirection), whereas above, I saw these as describing concepts that are generic. Although, one section "Guides" may be more appropriate with the <dt> saying what to expect from the content:
This guide explains how to...
There was a problem hiding this comment.
Yes, that would be my thought too. Every guide article should ideally be half concept-explaining and half usecase walkthrough.
There was a problem hiding this comment.
So the change here is that previously all the guide was grouped under tutorials and now you have split that into concepts and practical guides?
I think this is better that what was there and I don't have a better suggestion.
There was a problem hiding this comment.
previously all the guide was grouped under tutorials and now you have split that into concepts and practical guides
There was an HTTP guide nested under "Basics of HTTP", this PR brings these sub-pages into the index so the content is visible within the overall technology category. I think there's some opportunity to clean up / remove redundant info in future, but this is step one to tidying up.
concepts and practical guides
That was my first thought, but I'm not sure about making this separation, per Josh' comment.
Co-authored-by: Joshua Chen <[email protected]>
|
This pull request has merge conflicts that must be resolved before it can be merged. |
hamishwillee
left a comment
hamishwillee
left a comment
There was a problem hiding this comment.
@bsmth Does this need a review from me?
Thanks for checking, I think this is in a good state now, happy to hear your thoughts on the landing page |
|
Thank you. Merging, as "much better". |
* zh-cn: sync translated content * chore(http): delete "Basics of HTTP" page in favor of HTTP landing page ref: mdn/content#35774 * zh-cn: resolve the global function `createImageBitmap()` ref: mdn/content#35952 --------- Co-authored-by: Allo <[email protected]>
|
Thanks, both! Yari PR has been merged, so the sidebar changes will be landing soon. |
3 participants
Description
This PR removes the "Basics of HTTP" document in favor of using the https://developer.mozilla.org/en-US/docs/Web/HTTP landing page to list everything.
Motivation
There are guides that are less visible nested further down the tree, this surfaces those resources, and reorganizes the index for maintainability.
dependencies:
Yari sidebars need update to reflect removal:
Fixes #6955
Fixes #4922