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): Refresh headers ~[s->x] #36862

Merged
merged 30 commits into from
Dec 9, 2024
Merged

chore(http): Refresh headers ~[s->x] #36862

merged 30 commits into from
Dec 9, 2024

Conversation

bsmth
Copy link
Member

@bsmth bsmth commented Nov 19, 2024

Description

This PR refreshes a few HTTP headers pages.

common changes:

  • Add missing properties tables
  • Capitalize Yes/No in properties table & move verbose notes/caveats under table
  • Normalize The HTTP **`Header-Name`** (request|response) header in first sentence
  • Add status text to HTTPStatus macros, e.g. {{HTTPStatus("406", "406 Not Acceptable")}}
  • Improve Syntax section where possible
  • Remove improper use of quotes in and around code
  • Avoid escaping angle brackets in directive names in favor of backticks:
- \<directive>
+ `<directive>`

Motivation

Keeping content up-to-date, fixing formatting, unifying writing conventions

Additions:

  • Glossary/Source_map
  • Web/HTTP/Headers/X-Powered-By

TODOs

@github-actions github-actions bot added Content:HTTP HTTP docs Content:Glossary Glossary entries size/l [PR only] 501-1000 LoC changed labels Nov 19, 2024
Copy link
Contributor

github-actions bot commented Nov 19, 2024

Preview URLs (47 pages)
External URLs (37)

URL: /en-US/docs/Glossary/Source_map
Title: Source map


URL: /en-US/docs/Web/HTTP/Headers/Viewport-Width
Title: Viewport-Width


URL: /en-US/docs/Web/HTTP/Headers/WWW-Authenticate
Title: WWW-Authenticate


URL: /en-US/docs/Web/HTTP/Headers/X-Forwarded-For
Title: X-Forwarded-For


URL: /en-US/docs/Web/HTTP/Headers/Proxy-Authenticate
Title: Proxy-Authenticate


URL: /en-US/docs/Web/HTTP/Headers/Set-Login
Title: Set-Login


URL: /en-US/docs/Web/HTTP/Headers/Origin-Agent-Cluster
Title: Origin-Agent-Cluster


URL: /en-US/docs/Web/HTTP/Headers/Want-Repr-Digest
Title: Want-Repr-Digest


URL: /en-US/docs/Web/HTTP/Headers/Proxy-Authorization
Title: Proxy-Authorization


URL: /en-US/docs/Web/HTTP/Headers/SourceMap
Title: SourceMap


URL: /en-US/docs/Web/HTTP/Headers/Vary
Title: Vary


URL: /en-US/docs/Web/HTTP/Headers/TE
Title: TE


URL: /en-US/docs/Web/HTTP/Headers/X-Content-Type-Options
Title: X-Content-Type-Options


URL: /en-US/docs/Web/HTTP/Headers/Width
Title: Width


URL: /en-US/docs/Web/HTTP/Headers/Want-Content-Digest
Title: Want-Content-Digest


URL: /en-US/docs/Web/HTTP/Headers/Set-Cookie
Title: Set-Cookie


URL: /en-US/docs/Web/HTTP/Headers/Tk
Title: Tk


URL: /en-US/docs/Web/HTTP/Headers/Strict-Transport-Security
Title: Strict-Transport-Security

(comment last updated: 2024-12-09 15:59:50)

Copy link
Contributor

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

@github-actions github-actions bot removed the merge conflicts 🚧 [PR only] label Nov 25, 2024
@github-actions github-actions bot added size/xl [PR only] >1000 LoC changed and removed size/l [PR only] 501-1000 LoC changed labels Nov 27, 2024
@bsmth
Copy link
Member Author

bsmth commented Dec 2, 2024

This has cooked my brain :-0. Probably got a bit more sloppy towards the end.

Yes, I can imagine - thank you very much 🙏🏻

@bsmth bsmth requested a review from a team as a code owner December 6, 2024 11:38
@bsmth bsmth requested review from wbamberg and removed request for a team December 6, 2024 11:38
@github-actions github-actions bot added the Content:WebAPI Web API docs label Dec 6, 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.

Thanks @bsmth

I've added few minor comments/nits which you may or may not wish to consider. I think this all works. Approving for you to merge when you are happy,

@bsmth
Copy link
Member Author

bsmth commented Dec 9, 2024

Thank you Hamish for the patience and review rounds on this, the feedback has been really valuable 🙏🏻

I'm going to land this one now and look at the TODOs as follow-up tasks.

@bsmth bsmth merged commit ed04138 into mdn:main Dec 9, 2024
8 checks passed
@bsmth bsmth deleted the http-headers-s branch December 9, 2024 16:05
@hamishwillee
Copy link
Collaborator

You are most welcome. Feels good when stuff like this goes in!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Content:Glossary Glossary entries Content:HTTP HTTP docs Content:WebAPI Web API docs size/xl [PR only] >1000 LoC changed
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Incorrect WWW-Authenticate formats Default value of SameSite
2 participants