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 docs i-r #36079

Merged
merged 10 commits into from
Oct 24, 2024
Merged

Conversation

bsmth
Copy link
Member

@bsmth bsmth commented Sep 27, 2024

Description

This PR refreshes a few HTTP headers pages.

common changes:

  • Improve See also
  • Capitalize Yes/No in properties 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")}}
  • 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

Related pull requests:

@bsmth bsmth requested a review from a team as a code owner September 27, 2024 15:11
@bsmth bsmth requested review from hamishwillee and removed request for a team September 27, 2024 15:11
@github-actions github-actions bot added Content:HTTP HTTP docs size/l [PR only] 501-1000 LoC changed labels Sep 27, 2024
Copy link
Contributor

github-actions bot commented Sep 27, 2024

Preview URLs (20 pages)
External URLs (8)

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


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


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


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


URL: /en-US/docs/Web/HTTP/Headers/Referrer-Policy
Title: Referrer-Policy


URL: /en-US/docs/Web/HTTP/Headers/If-Unmodified-Since
Title: If-Unmodified-Since


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

(comment last updated: 2024-10-23 10:44:34)

@hamishwillee
Copy link
Collaborator

@bsmth Looks great. A few merged comments, and a few for discussion - all pretty minor

@github-actions github-actions bot added size/m [PR only] 51-500 LoC changed and removed size/l [PR only] 501-1000 LoC changed labels Oct 1, 2024
@github-actions github-actions bot added size/l [PR only] 501-1000 LoC changed and removed size/m [PR only] 51-500 LoC changed labels Oct 1, 2024
@github-actions github-actions bot added the merge conflicts 🚧 [PR only] label Oct 14, 2024
Copy link
Contributor

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

@bsmth bsmth self-assigned this Oct 21, 2024
@github-actions github-actions bot removed the merge conflicts 🚧 [PR only] label Oct 23, 2024
bsmth and others added 2 commits October 23, 2024 11:23
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
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 very much @bsmth - LGTM now!

@hamishwillee hamishwillee merged commit cadc98b into mdn:main Oct 24, 2024
8 checks passed
@bsmth bsmth deleted the http-headers-l branch October 28, 2024 08:40
@bsmth
Copy link
Member Author

bsmth commented Oct 28, 2024

Super, thank you, Hamish 👍🏻

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Content:HTTP HTTP docs size/l [PR only] 501-1000 LoC changed
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants