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 "Digest" and "Want-Digest", improve digest pages #36879

Merged
merged 14 commits into from
Nov 25, 2024

Conversation

bsmth
Copy link
Member

@bsmth bsmth commented Nov 20, 2024

Description

This PR removes the Digest and Want-Digest pages which are deprecated. They are also confusing, given the pages are mixed in with newer alternatives. I'm proposing we redirect to content-related digest headers.

Deletions:

  • Digest header, redirected to Content-Digest
  • Want-Digest header, redirected to Want-Content-Digest

Changes:

  • Language in Repr-Digest and Content-Digest pages for clarity
  • spec_urls front matter should be spec-urls

Additions:

  • Some more examples in Content-Digest based on specs

Motivation

The remaining pages were touched recently, but I think there's room for improvement in the language used so that it's easier to understand when/why to use Repr-Digest instead of Content-Digest.

Related issues and pull requests

@bsmth bsmth requested review from a team as code owners November 20, 2024 11:29
@bsmth bsmth requested review from hamishwillee and removed request for a team November 20, 2024 11:29
@github-actions github-actions bot added Content:HTTP HTTP docs Content:Glossary Glossary entries Content:Meta Content in the meta docs size/m [PR only] 51-500 LoC changed labels Nov 20, 2024
Copy link
Contributor

github-actions bot commented Nov 20, 2024

Preview URLs (7 pages)
External URLs (16)

URL: /en-US/docs/Glossary/Representation_header
Title: Representation header


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


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


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

(comment last updated: 2024-11-25 09:00:39)

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.

Looks pretty good. Was tempted to merge, but perhaps worth leaving open for you to see if you want to address any of the comments.

@bsmth bsmth requested a review from hamishwillee November 22, 2024 11:57
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 Looks great, except perhaps for suggestion in #36879 (comment)

Approving so you can merge once that's had a look

Co-authored-by: Hamish Willee <hamishwillee@gmail.com>
@bsmth bsmth merged commit a8f8816 into mdn:main Nov 25, 2024
9 checks passed
@bsmth bsmth deleted the http-digest-headers branch November 25, 2024 09:00
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:Meta Content in the meta docs size/m [PR only] 51-500 LoC changed
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants