Skip to content

chore(http): Refresh some headers pages (~a-c)#36038

Merged
dipikabh merged 24 commits intomdn:mainfrom
bsmth:http-headers-a
Oct 30, 2024
Merged

chore(http): Refresh some headers pages (~a-c)#36038
dipikabh merged 24 commits intomdn:mainfrom
bsmth:http-headers-a

Conversation

@bsmth
Copy link
Copy Markdown
Member

@bsmth bsmth commented Sep 25, 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

Notes

@bsmth bsmth requested a review from a team as a code owner September 25, 2024 08:51
@bsmth bsmth requested review from Elchi3 and removed request for a team September 25, 2024 08:51
@github-actions github-actions bot added the Content:HTTP HTTP docs label Sep 25, 2024
@github-actions github-actions bot added the size/l [PR only] 501-1000 LoC changed label Sep 25, 2024
@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Sep 25, 2024

Preview URLs (42 pages)
Flaws (3)

Note! 40 documents with no flaws that don't need to be listed. 🎉

URL: /en-US/docs/Web/HTTP/Headers/Accept-Patch
Title: Accept-Patch
Flaw count: 2

  • broken_links:
    • Can't resolve /en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types
    • Can't resolve /en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types

URL: /en-US/docs/Web/HTTP/Headers/Accept-Post
Title: Accept-Post
Flaw count: 1

  • broken_links:
    • Can't resolve /en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types
External URLs (13)

URL: /en-US/docs/Web/HTTP/Headers/Accept-Ranges
Title: Accept-Ranges


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


URL: /en-US/docs/Web/HTTP/Headers/Accept-Encoding
Title: Accept-Encoding


URL: /en-US/docs/Web/HTTP/Headers/Accept-Patch
Title: Accept-Patch


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


URL: /en-US/docs/Web/HTTP/Headers/Accept-Post
Title: Accept-Post


URL: /en-US/docs/Web/HTTP/Headers/Alt-Svc
Title: Alt-Svc


URL: /en-US/docs/Web/HTTP/Headers/Cross-Origin-Resource-Policy
Title: Cross-Origin-Resource-Policy


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

(comment last updated: 2024-10-30 11:19:50)

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

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

@github-actions github-actions bot added merge conflicts 🚧 [PR only] and removed merge conflicts 🚧 [PR only] labels Sep 25, 2024
@github-actions
Copy link
Copy Markdown
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 Sep 26, 2024
@bsmth bsmth changed the title chore(http): Refresh some headers pages chore(http): Refresh some headers pages (~a-c) Sep 26, 2024
@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Oct 1, 2024

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 Oct 2, 2024
@bsmth bsmth linked an issue Oct 2, 2024 that may be closed by this pull request
@dipikabh dipikabh self-assigned this Oct 22, 2024
Copy link
Copy Markdown
Contributor

@dipikabh dipikabh left a comment

Choose a reason for hiding this comment

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

Reviewed till accept-patch. I'll look at the remaining files tomorrow.

- : Any value placed in an order of preference expressed using a relative {{Glossary("Quality values", "quality value")}} called _weight_.

## Examples

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Would be nice to add an H3 and some prose here

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

done in ba0922f

Copy link
Copy Markdown
Contributor

@dipikabh dipikabh left a comment

Choose a reason for hiding this comment

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

Reviewed till content-location

Copy link
Copy Markdown
Contributor

@dipikabh dipikabh left a comment

Choose a reason for hiding this comment

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

Done with the remaining. Thanks for the updates, @bsmth!

@Elchi3 Elchi3 removed their request for review October 28, 2024 12:40
Co-authored-by: Dipika Bhattacharya <dipika@foss-community.org>
bsmth and others added 2 commits October 29, 2024 18:32
Co-authored-by: Dipika Bhattacharya <dipika@foss-community.org>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
@bsmth
Copy link
Copy Markdown
Member Author

bsmth commented Oct 29, 2024

Thank you @dipikabh - I have some suggestions from you to work on. I will re-request when it's ready for another look 👀

@dipikabh
Copy link
Copy Markdown
Contributor

@bsmth, you might want to look into this "Browser compatibility" section verbiage I came across in our page templates: https://developer.mozilla.org/en-US/docs/MDN/Writing_guidelines/Page_structures/Page_types/HTTP_header_page_template#browser_compatibility

@bsmth bsmth requested a review from dipikabh October 30, 2024 11:20
@bsmth
Copy link
Copy Markdown
Member Author

bsmth commented Oct 30, 2024

@dipikabh I think this one's ready for another look 👀

Copy link
Copy Markdown
Contributor

@dipikabh dipikabh left a comment

Choose a reason for hiding this comment

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

The updates look good. Thanks a lot, @bsmth 🎉

@dipikabh dipikabh merged commit 92b03e4 into mdn:main Oct 30, 2024
@bsmth bsmth deleted the http-headers-a branch October 31, 2024 09:07
@bsmth
Copy link
Copy Markdown
Member Author

bsmth commented Oct 31, 2024

Thank you, Dipika 🙏🏻

fiji-flo pushed a commit that referenced this pull request Oct 31, 2024
* chore(http): Refresh headers docs

* chore(http): Refresh headers docs

* chore(http): Refresh headers docs

* chore(http): Remove bogus Content-Location header example

* Apply suggestions from code review

Co-authored-by: Dipika Bhattacharya <dipika@foss-community.org>

* chore(http): Add glossary links to request and response header terms

* Update files/en-us/web/http/headers/access-control-allow-headers/index.md

Co-authored-by: Dipika Bhattacharya <dipika@foss-community.org>

* chore(http): Changes following reviewer feedback

* Apply suggestions from code review

Co-authored-by: Dipika Bhattacharya <dipika@foss-community.org>

* Apply suggestions from code review

Co-authored-by: Dipika Bhattacharya <dipika@foss-community.org>

* Update files/en-us/web/http/headers/clear-site-data/index.md

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

* chore(http): Changes following reviewer feedback

* chore(http): Changes following reviewer feedback

* chore(http): Changes following reviewer feedback

* chore(http): Changes following reviewer feedback

* chore(http): Glossary links to request / response headers

---------

Co-authored-by: Dipika Bhattacharya <dipika@foss-community.org>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Nov 1, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

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.

Issue with "Content-Location": for 201 Created, use Location instead

2 participants