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

Add client hint docs: Downlink, ECT, RTT #5883

Merged
merged 26 commits into from
Jun 18, 2021
Merged

Conversation

hamishwillee
Copy link
Collaborator

@hamishwillee hamishwillee commented Jun 11, 2021

This header is in the Network Information spec here: https://wicg.github.io/netinfo/#rtt-request-header-field

There is not all that much information, but you can see it is associated with the NetworkInformation.rtt and there is some useful general guidance in https://developers.google.com/web/fundamentals/performance/optimizing-content-efficiency/client-hints.

Spec update is in mdn/browser-compat-data#10951

This is another part of #1408

@hamishwillee hamishwillee requested review from a team as code owners June 11, 2021 07:13
@hamishwillee hamishwillee requested review from mirunacurtean and Elchi3 and removed request for a team June 11, 2021 07:13
@github-actions
Copy link
Contributor

github-actions bot commented Jun 11, 2021

Preview URLs

Flaws

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

URL: /en-US/docs/Web/API/NetworkInformation/downlink
Title: NetworkInformation.downlink
on GitHub
Flaw count: 1

  • macros:
    • /en-US/docs/Web/JavaScript/Reference/double does not exist

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

  • macros:
    • /en-US/docs/Glossary/COEP does not exist
    • /en-US/docs/Glossary/COOP does not exist
    • /en-US/docs/Glossary/CORP does not exist
  • broken_links:
    • Can't resolve /en-US/docs/Web/API/Save_Data_API

External URLs

URL: /en-US/docs/Glossary/Effective_connection_type
Title: Effective connection type
on GitHub

No new external URLs


URL: /en-US/docs/Glossary/Client_hints
Title: Client hints
on GitHub

No new external URLs


URL: /en-US/docs/Web/API/NetworkInformation/rtt
Title: NetworkInformation.rtt
on GitHub

No new external URLs


URL: /en-US/docs/Web/API/NetworkInformation/downlink
Title: NetworkInformation.downlink
on GitHub

No new external URLs


URL: /en-US/docs/Web/API/NetworkInformation/saveData
Title: NetworkInformation.saveData
on GitHub

No new external URLs


URL: /en-US/docs/Web/API/NetworkInformation/effectiveType
Title: NetworkInformation.effectiveType
on GitHub

No new external URLs


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

No new external URLs


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


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


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


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


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

No new external URLs


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

(this comment was updated 2021-06-18 01:54:46.742637)

@hamishwillee hamishwillee requested a review from a team as a code owner June 15, 2021 07:24
@hamishwillee hamishwillee requested review from Rumyra and removed request for a team June 15, 2021 07:24
@hamishwillee
Copy link
Collaborator Author

@Elchi3 OK, this got bigger

  • I added the missing network headers ECT and Downlink
  • Updated Save-Data to better cross link.
  • Cross linked all of these to the equivalent web API
  • Added sections for client headers in both the main headers page and in the client headers page.

I think this is a good place to stop for now. In future though it might be worth having a client headers guide much like https://developers.google.com/web/fundamentals/performance/optimizing-content-efficiency/client-hints and cut back the glossary entry. This gives us a structure to work with now though.

Can you please review again :-)

Copy link
Member

@Elchi3 Elchi3 left a comment

Choose a reason for hiding this comment

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

Thanks for your work! Some comments.

files/en-us/glossary/client_hints/index.html Outdated Show resolved Hide resolved
files/en-us/glossary/client_hints/index.html Outdated Show resolved Hide resolved
files/en-us/glossary/client_hints/index.html Outdated Show resolved Hide resolved
files/en-us/glossary/client_hints/index.html Outdated Show resolved Hide resolved
files/en-us/web/http/headers/accept-ch/index.html Outdated Show resolved Hide resolved
files/en-us/web/http/headers/rtt/index.html Show resolved Hide resolved
files/en-us/web/http/headers/rtt/index.html Outdated Show resolved Hide resolved
files/en-us/web/http/headers/rtt/index.html Outdated Show resolved Hide resolved
files/en-us/web/http/headers/rtt/index.html Outdated Show resolved Hide resolved
files/en-us/web/http/headers/save-data/index.html Outdated Show resolved Hide resolved
hamishwillee and others added 9 commits June 18, 2021 11:13
Co-authored-by: Florian Scholz <fs@florianscholz.com>
Co-authored-by: Florian Scholz <fs@florianscholz.com>
Co-authored-by: Florian Scholz <fs@florianscholz.com>
Co-authored-by: Florian Scholz <fs@florianscholz.com>
Co-authored-by: Florian Scholz <fs@florianscholz.com>
Co-authored-by: Florian Scholz <fs@florianscholz.com>
Co-authored-by: Florian Scholz <fs@florianscholz.com>
Co-authored-by: Florian Scholz <fs@florianscholz.com>
hamishwillee and others added 10 commits June 18, 2021 11:20
Co-authored-by: Florian Scholz <fs@florianscholz.com>
Co-authored-by: Florian Scholz <fs@florianscholz.com>
Co-authored-by: Florian Scholz <fs@florianscholz.com>
Co-authored-by: Florian Scholz <fs@florianscholz.com>
Co-authored-by: Florian Scholz <fs@florianscholz.com>
Co-authored-by: Florian Scholz <fs@florianscholz.com>
Co-authored-by: Florian Scholz <fs@florianscholz.com>
Co-authored-by: Florian Scholz <fs@florianscholz.com>
Co-authored-by: Florian Scholz <fs@florianscholz.com>
@hamishwillee hamishwillee requested a review from Elchi3 June 18, 2021 01:53
@hamishwillee
Copy link
Collaborator Author

@Elchi3 Thanks for the detailed review - I seem to have injected more errors than usual :-(.

I accepted all changes, added directives sections, reverted the specifications section. Note that I kept the specifications macro for the new header docs. Yes they show missing info now, but I'm hoping that the spec issue will be resolved soon and don't think it worth adding the manual table while we wait. Happy to add a manual table if you think this is a "requirement".

@Elchi3
Copy link
Member

Elchi3 commented Jun 18, 2021

Note that I kept the specifications macro for the new header docs. Yes they show missing info now, but I'm hoping that the spec issue will be resolved soon and don't think it worth adding the manual table while we wait. Happy to add a manual table if you think this is a "requirement".

This was the correct call! These headers use https://wicg.github.io/netinfo/ which does in fact work as soon as the latest BCD is on MDN production in a few hours. What doesn't work right now is HTTP features that reference IETF specs. You can follow w3c/browser-specs#280 to be notified when it's available upstream.

@Elchi3 Elchi3 changed the title HTTP RTT Header - client hint doc Add client hint docs: Downlink, ECT, RTT Jun 18, 2021
Copy link
Member

@Elchi3 Elchi3 left a comment

Choose a reason for hiding this comment

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

Thanks Hamish, fantastic work! 👍

@Elchi3 Elchi3 merged commit 2659609 into mdn:main Jun 18, 2021
@hamishwillee hamishwillee deleted the http_rtt branch June 20, 2021 23:52
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Aug 4, 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.

2 participants