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

Remove mentions of historic Accept-Charset header #4250

Merged
merged 5 commits into from
Apr 27, 2021

Conversation

ddbeck
Copy link
Contributor

@ddbeck ddbeck commented Apr 19, 2021

What was wrong/why is this fix needed? (quick summary only)

Over in BCD, we're inclined to drop Accept-Charset. Browsers haven't sent this header for many, many years (IE since 2008, Chrome since 2013). After giving it some thought, I think mentioning in this decade confuses more than informs. Some text I removed makes a pretty good case for me:

With UTF-8 now being well-supported, being the preferred way of encoding characters, and to guarantee better privacy through less configuration-based entropy, browsers omit the Accept-Charset header: Internet Explorer 8, Safari 5, Opera 11, Firefox 10 and Chrome 27 have abandoned this header.

Nobody ought to send this header, servers ought to ignore it, and it's interesting mostly as a historic artifact. This PR scrubs most mentions of the header (except as one of the forbidden header names) and deletes the reference page.

MDN URL of main page changed

https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Charset

Over in BCD, we're inclined to drop `Accept-Charset`. Browsers haven't
sent this header for many, many years. After giving it some thought I
think mentioning in this decade confuses more than informs.

mdn/browser-compat-data#9610 (comment)
@ddbeck ddbeck requested review from a team as code owners April 19, 2021 12:32
@ddbeck ddbeck requested review from chrisdavidmills and removed request for a team April 19, 2021 12:32
@ddbeck
Copy link
Contributor Author

ddbeck commented Apr 19, 2021

@wbamberg Perhaps of interest to you, since you and I chatted about it previously.

@github-actions
Copy link
Contributor

github-actions bot commented Apr 19, 2021

Preview URLs

Flaws

URL: /en-US/docs/MDN/Structures/Compatibility_tables
Title: Compatibility tables and the browser compatibility data repository (BCD)
on GitHub

No flaws! 🎉


URL: /en-US/docs/Web/HTTP/Headers
Title: HTTP headers
on GitHub
Flaw count: 2

  • heading_links:
    • h2 heading contains an <a> tag
    • h3 heading contains an <a> tag

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

No flaws! 🎉


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

No flaws! 🎉


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

No flaws! 🎉


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

No flaws! 🎉


URL: /en-US/docs/Web/HTTP/Status/406
Title: 406 Not Acceptable
on GitHub

No flaws! 🎉


URL: /en-US/docs/Web/HTTP/Content_negotiation
Title: Content negotiation
on GitHub

No flaws! 🎉


URL: /en-US/docs/Web/API/Headers/Headers
Title: Headers()
on GitHub

No flaws! 🎉


URL: /en-US/docs/Glossary/Quality_values
Title: Quality values
on GitHub

No flaws! 🎉

External URLs

URL: /en-US/docs/MDN/Structures/Compatibility_tables
Title: Compatibility tables and the browser compatibility data repository (BCD)
on GitHub

No external URLs

URL: /en-US/docs/Web/HTTP/Headers
Title: HTTP headers
on GitHub


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


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


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


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


URL: /en-US/docs/Web/HTTP/Status/406
Title: 406 Not Acceptable
on GitHub


URL: /en-US/docs/Web/HTTP/Content_negotiation
Title: Content negotiation
on GitHub


URL: /en-US/docs/Web/API/Headers/Headers
Title: Headers()
on GitHub


URL: /en-US/docs/Glossary/Quality_values
Title: Quality values
on GitHub

(this comment was updated 2021-04-26 16:58:52.162579)

(this comment was updated 2021-04-27 12:58:16.996664)

(this comment was updated 2021-04-27 13:02:06.244975)

@hamishwillee
Copy link
Collaborator

FWIW If it were me I would keep the Accept-Charset page itself and the BCD entry, but replace most of the content with a single note capturing your points above - essentially it should not be used. The rest of the PR is great.

Why? Well, the header is still in live specs, and at some point people will reasonably search for it - resulting in "why haven't you got information on this" questions. I'd rather we had a minimal placeholder that explains that it exists but should not be used and that we have deliberately decided not to include info for it everywhere.

@ddbeck
Copy link
Contributor Author

ddbeck commented Apr 21, 2021

I'm more set on removing the BCD than I am removing the page. It meets all our criteria for removal and is the last feature between us and a stronger data quality check.

So if we let the page stand, then we'd have to drop the compat section and, with the progress being made on generated spec tables, the specifications would go someday too. It's a very thin page at that point.

@hamishwillee
Copy link
Collaborator

@ddbeck Perhaps I wasn't clear in #4250 (comment) - I am absolutely happy with removing BCD and most of this cleanup. I am also already suggesting a much much thinner version of the doc - so that does not phase me.

Essentially the difference is that in your proposal the header is missing even though it is in the specification - so we look like we're doing a crap job, and there is no way for anyone to know they shouldn't use it. With my proposal people can find the doc which says "don't use this".

Does that make sense?

@chrisdavidmills
Copy link
Contributor

I think I agree with Hamish's proposal here. For something that was supported, but not isn't, it is useful to have a page available with a definitive conclusion on it of "this isn't supported, don't use this". Having nothing would lead to uncertainty.

In the past, the main cases in which we've removed pages are cases in which something was documented early, but then was never actually implemented. That's a bit different.

@ddbeck
Copy link
Contributor Author

ddbeck commented Apr 26, 2021

For some reason, the preview comment doesn't mention the page, but I've reinstated it, revised a little, and dropped most of its content:

https://pr4250.content.dev.mdn.mozit.cloud/en-US/docs/Web/HTTP/Headers/Accept-Charset

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.

@ddbeck Works for me (so approved). How about we add a deprecation warning up the top like this:

{{Deprecated_Header}}
<div class="notecard warning">
  <h4>Warning</h4>
  <p>Do not use this header. It has not sent by any major browser for many years and should be ignored by servers.</p>
</div>

@ddbeck
Copy link
Contributor Author

ddbeck commented Apr 27, 2021

@hamishwillee I tried your suggestion, but {{Deprecated_Header}} links to the (now non-existent) compat section, which feels pretty broken. (Also, it is so, so wordy.) So I removed it, but I left the warning as suggested.

@hamishwillee
Copy link
Collaborator

Awesome. Thanks!

@hamishwillee hamishwillee merged commit ecdd031 into mdn:main Apr 27, 2021
@ddbeck ddbeck deleted the remove-accept-charset branch April 29, 2021 15:31
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Aug 14, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants