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

chore(http): delete "Basics of HTTP" page in favor of HTTP landing page, reorganize index #35774

Merged
merged 13 commits into from
Oct 1, 2024

Conversation

bsmth
Copy link
Member

@bsmth bsmth commented Sep 6, 2024

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

@bsmth bsmth requested review from a team as code owners September 6, 2024 13:19
@bsmth bsmth requested review from pepelsbey, wbamberg, hamishwillee and estelle and removed request for a team September 6, 2024 13:19
@github-actions github-actions bot added Content:HTML Hypertext Markup Language docs Content:WebAPI Web API docs Content:JS JavaScript docs Content:Learn Learning area docs Content:Other Any docs not covered by another "Content:" label Content:HTTP HTTP docs Content:Glossary Glossary entries Content:Security Security docs Content:Firefox Content in the Mozilla/Firefox subtree Content:Learn:Forms Learning area Forms docs Content:Manifest labels Sep 6, 2024
@bsmth bsmth marked this pull request as draft September 7, 2024 10:25
Copy link
Contributor

github-actions bot commented Sep 9, 2024

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 Sep 9, 2024
@github-actions github-actions bot removed the merge conflicts 🚧 [PR only] label Sep 9, 2024
@Josh-Cena
Copy link
Member

@bsmth can we get this merged despite the Yari PR? We need to merge this beforehand anyway.

@bsmth
Copy link
Member Author

bsmth commented Sep 25, 2024

@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 HTTP/Basics_of_HTTP in the sidebar redirecting to /HTTP while the Yari PR is in-flight.

@bsmth bsmth marked this pull request as ready for review September 25, 2024 16:09
Copy link
Member

@Josh-Cena Josh-Cena left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 Show resolved Hide resolved
Comment on lines 66 to 68
## Practical and topical guides

## Reference
Learn about common communication patterns and methods for improving security, resource usage and network efficiency.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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...

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, that would be my thought too. Every guide article should ideally be half concept-explaining and half usecase walkthrough.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

@github-actions github-actions bot added the merge conflicts 🚧 [PR only] label Sep 29, 2024
Copy link
Contributor

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

@Josh-Cena Josh-Cena removed the do not merge [PR only] Not ready to land label Sep 29, 2024
Copy link
Collaborator

@hamishwillee hamishwillee left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@bsmth Does this need a review from me?

@github-actions github-actions bot removed the merge conflicts 🚧 [PR only] label Oct 1, 2024
@bsmth
Copy link
Member Author

bsmth commented Oct 1, 2024

@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

Copy link
Member

@Josh-Cena Josh-Cena left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks great!

@hamishwillee
Copy link
Collaborator

Thank you. Merging, as "much better".

@hamishwillee hamishwillee merged commit f75b2c8 into mdn:main Oct 1, 2024
9 checks passed
yin1999 added a commit to mdn/translated-content that referenced this pull request Oct 2, 2024
yin1999 added a commit to mdn/translated-content that referenced this pull request Oct 2, 2024
* 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]>
@bsmth bsmth deleted the http-page branch October 2, 2024 12:19
@bsmth
Copy link
Member Author

bsmth commented Oct 2, 2024

Thanks, both! Yari PR has been merged, so the sidebar changes will be landing soon.

sora32127 pushed a commit to sora32127/translated-content that referenced this pull request Oct 6, 2024
* 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]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Content:Firefox Content in the Mozilla/Firefox subtree Content:Glossary Glossary entries Content:HTML Hypertext Markup Language docs Content:HTTP HTTP docs Content:JS JavaScript docs Content:Learn:Forms Learning area Forms docs Content:Learn Learning area docs Content:Manifest Content:Other Any docs not covered by another "Content:" label Content:PWA Progressive Web Apps content Content:Security Security docs Content:WebAPI Web API docs size/m [PR only] 51-500 LoC changed
Projects
None yet
3 participants