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

Fix broken fragment references in spec #818

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Fix broken fragment references in spec #818

wants to merge 3 commits into from

Conversation

tidoust
Copy link
Member

@tidoust tidoust commented Nov 18, 2024

This fixes broken and obsolete fragment references in the spec.

Most updates are straightforward. A few notes:

  • tools.ietf.org now redirects to datatracker.ietf.org
  • The update drops any link to "handled" in HTML. Not sure where the term was defined but it no longer seems to exist.
  • "default classic script fetch options" is "default script fetch options" in practice. If "classic" matters, then that term no longer exists!

Not done as part of this update, but some of the references can likely be handled directly by Bikeshed without having to define more brittle anchors.


Preview | Diff

This fixes broken and obsolete fragment references in the spec.

Most updates are straightforward. A few notes:
- `tools.ietf.org` now redirects to `datatracker.ietf.org`
- The update drops any link to "handled" in HTML. Not sure where the term was
defined but it no longer seems to exist.
- "default classic script fetch options" is "default script fetch options" in
practice. If "classic" matters, then that term no longer exists!

Not done as part of this update, but some of the references can likely be
handled directly by Bikeshed without having to define more brittle anchors.
@whimboo
Copy link
Contributor

whimboo commented Nov 20, 2024

* `tools.ietf.org` now redirects to `datatracker.ietf.org`

Interesting, for me it actually forwards to https://authors.ietf.org/.

@tidoust
Copy link
Member Author

tidoust commented Nov 20, 2024

* `tools.ietf.org` now redirects to `datatracker.ietf.org`

Interesting, for me it actually forwards to https://authors.ietf.org/.

Ah, indeed, I hadn't noticed that the root URL forwarded somewhere else! I should have been more complete, as in "https://tools.ietf.org/html/rfc* now redirects to the RFC under datatracker.ietf.org". WebDriver Bidi links to RFCs, not to https://tools.ietf.org directly, for example: https://tools.ietf.org/html/rfc4648 forwards to https://datatracker.ietf.org/doc/html/rfc4648.

@whimboo whimboo requested a review from jgraham November 25, 2024 21:28
Copy link
Member

@jgraham jgraham left a comment

Choose a reason for hiding this comment

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

A couple of comments, but this seems like a strict improvement, thanks!

Agreed that we should use the autorefs more often; sometimes we're poking at deep parts of specs that intentionally aren't exported, but at least with WebDriver we could export more terms to avoid needing to use so many hardcoded refs.

index.bs Outdated Show resolved Hide resolved
index.bs Outdated
text: Cookie; url: section-5.3
text: Cookie store; url: section-5.3
spec: RFC6265bis; urlPrefix: https://tools.ietf.org/html/draft-ietf-httpbis-rfc6265bis-05
text: Cookie; url: storage-model
Copy link
Member

Choose a reason for hiding this comment

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

It feels like this was always linking to the wrong thing. Seems like maybe it should just link to #intro for the definition of a Cookie.

Copy link
Member Author

Choose a reason for hiding this comment

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

I updated the link to target the whole RFC (no fragment), which seems good enough?

Copy link
Member

Choose a reason for hiding this comment

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

I think the "Cookie store" link should revert to targeting section 5.3 which describes how a client stores cookies.

Copy link
Member

Choose a reason for hiding this comment

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

But a link to the whole document is fine for Cookie.

No real anchor to provide there, just a link to the spec
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants