Skip to content

Compression Dictionary Transport updates#38974

Merged
wbamberg merged 15 commits intomdn:mainfrom
tunetheweb:compresson-dictionary-transport-sidebar
Apr 9, 2025
Merged

Compression Dictionary Transport updates#38974
wbamberg merged 15 commits intomdn:mainfrom
tunetheweb:compresson-dictionary-transport-sidebar

Conversation

@tunetheweb
Copy link
Copy Markdown
Contributor

Description

Follow on from #38722 (reviewed by @wbamberg ) I noticed the new guide wasn't showing in the sidebar.

I've also added more front matter to flag this as experimental and also add Spec and Compatibility table.

Finally, I've also added a bit more explanation of id/Dictionary-ID as raised at #38948 (comment) by @hamishwillee

Motivation

More helpful to devs when viewing the guide.

Additional details

Related issues and pull requests

An update to #38722
Also discussed in #38948

@tunetheweb tunetheweb requested review from a team as code owners April 4, 2025 13:54
@tunetheweb tunetheweb requested review from bsmth and hamishwillee and removed request for a team April 4, 2025 13:54
@github-actions github-actions bot added Content:HTTP HTTP docs size/s [PR only] 6-50 LoC changed labels Apr 4, 2025
@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Apr 4, 2025

Preview URLs

Flaws (1)

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

URL: /en-US/docs/Web/HTTP/Guides/Compression_dictionary_transport
Title: Compression Dictionary Transport
Flaw count: 1

  • unknown:
    • No generic content config found

(comment last updated: 2025-04-09 11:02:01)

@Josh-Cena
Copy link
Copy Markdown
Member

This is a minor point. https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/rel does not link to https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/rel/compression-dictionary. Could you link to it somehow, such as in the table (following dns-prefetch), or in the DL below?

@tunetheweb tunetheweb requested a review from a team as a code owner April 4, 2025 18:50
@tunetheweb tunetheweb requested review from chrisdavidmills and removed request for a team April 4, 2025 18:50
@github-actions github-actions bot added the Content:HTML Hypertext Markup Language docs label Apr 4, 2025
@github-actions github-actions bot added size/m [PR only] 51-500 LoC changed and removed size/s [PR only] 6-50 LoC changed labels Apr 4, 2025
@tunetheweb
Copy link
Copy Markdown
Contributor Author

This is a minor point. https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/rel does not link to https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/rel/compression-dictionary. Could you link to it somehow, such as in the table (following dns-prefetch), or in the DL below?

Done!

Copy link
Copy Markdown
Collaborator

@wbamberg wbamberg left a comment

Choose a reason for hiding this comment

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

I just had one comment on the spec/BCD additions - we don't generally include this in guide pages.

I'll leave the comments on DictionaryId to @hamishwillee because it was his comment :).

Comment on lines +5 to +16
status:
- experimental
browser-compat:
- html.elements.link.rel.compression-dictionary
- http.headers.Accept-Encoding.dcb
- http.headers.Accept-Encoding.dcz
- http.headers.Available-Dictionary
- http.headers.Content-Encoding.dcb
- http.headers.Content-Encoding.dcz
- http.headers.Dictionary-ID
- http.headers.Use-As-Dictionary
spec-urls: https://datatracker.ietf.org/doc/html/draft-ietf-httpbis-compression-dictionary
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

We don't generally include spec tables or BCD in guide pages, only in reference pages.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

That's what I thought too — hence why I didn't include it originally.

However, I noticed for Permissions Policy we do include these.

I think that while a technology is "experimental" (like Permissions Policy and Compression Dictionary Transport are) that's a pretty good idea to mark it as such and include the full things.

The rest of the HTTP guides really are for core concepts that are supported by all browsers, so including BCD is not really necessary — though specs still seem like good ideas to me in some case. The only other similar case (that probably should be marked as experimental and treated similarly) is HTTP Client Hints, but will leave that for now and stick to Compression Dictionary Transport for this PR.

WDYT?

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

@wbamberg I looked at the bits that were associated with other work I am doing, but not the rest since you reviewed that.

This bit is the only outstanding discussion and is waiting on you.

FWIW We are not consistent on this. I think the rule is understood, but isn't followed because it isn't that helpful to readers.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

I've tried to ask for more feedback from other maintainers on this but not got much in the way of definitive responses.

But I'm tired of arguing about consistency and structure, and I don't think there's anything to say that hasn't already been said, so I'm not going to block the PR on this.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Fair enough. I tend to accept things if I think they are good or not actively harmful in cases like this. Not worth banging your head against the wall for.

@chrisdavidmills chrisdavidmills removed their request for review April 6, 2025 11:34
tunetheweb and others added 2 commits April 7, 2025 07:41
Co-authored-by: Hamish Willee <hamishwillee@gmail.com>
Co-authored-by: Hamish Willee <hamishwillee@gmail.com>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
@bsmth
Copy link
Copy Markdown
Member

bsmth commented Apr 7, 2025

Thank you! There's enough eyes on this so I'm taking myself off review 🙏🏻

@bsmth bsmth removed their request for review April 7, 2025 08:52
@wbamberg wbamberg merged commit ae1d236 into mdn:main Apr 9, 2025
8 checks passed
cssinate pushed a commit to cssinate/content that referenced this pull request Apr 11, 2025
* Fix Compression Dictionary Transport sidebar and add more front matter

* Add mroe BCD to guide and explain Dictionary Id better

* Tweaks

* review-feedback

* linting

* Review-feedback

* Update files/en-us/web/http/reference/headers/dictionary-id/index.md

Co-authored-by: Hamish Willee <hamishwillee@gmail.com>

* Update files/en-us/web/http/reference/headers/dictionary-id/index.md

Co-authored-by: Hamish Willee <hamishwillee@gmail.com>

* Update files/en-us/web/http/reference/headers/dictionary-id/index.md

* Update files/en-us/web/http/reference/headers/dictionary-id/index.md

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

---------

Co-authored-by: Hamish Willee <hamishwillee@gmail.com>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: Brian Smith <brian@smith.berlin>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Content:HTML Hypertext Markup Language docs Content:HTTP HTTP docs size/m [PR only] 51-500 LoC changed

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants