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

Links to GitHub references that could be W3C references (link stability) #2333

Closed
svgeesus opened this issue Apr 30, 2021 · 7 comments
Closed

Comments

@svgeesus
Copy link
Contributor

Describe the issue

Several links point to drafts on GitHub when they could point to a stable W3C source instead. Some of those might automatically be fixed when the bikeshed Prepare for TR: Yes directive is used.

Where Is It

https://w3c.github.io/hr-time/ should link to https://www.w3.org/TR/hr-time-3/ which is a W3C Working Draft 24 March 2021

https://w3c.github.io/mediacapture-fromelement/ should link to https://www.w3.org/TR/mediacapture-fromelement/ which is a W3C Working Draft 19 January 2021

https://w3ctag.github.io/security-questionnaire/ should link to https://www.w3.org/TR/security-privacy-questionnaire/ which is a W3C Working Group Note, 23 March 2021

https://webaudio.github.io/Audio-EQ-Cookbook/audio-eq-cookbook.html should link to an archived copy on W3C site (regardless of whether we use the GitHub copy for maintenance). One possibility would be to issue it as a W3C Note. But we could also just put a copy somewhere in W3C space.

@rtoy
Copy link
Member

rtoy commented Apr 30, 2021

Looks like all the links you mention are explicit <a href> links, so these will need to be updated.

For the cookbook, the current W3C archive version is incorrect or badly formatted in some places. It would be great if we could update the current version.

But in the long term it might be better have that as a W3C Note so that it can be updated as needed. (I don't foresee any real updates, thought. I've gone over it with Robert Bristow-Johnson a while back, and I think everything is correct. He did want to add some diagrams and such, but that's not really necessary.)

@svgeesus
Copy link
Contributor Author

Do you recall where the W3C version is?

I agree that having a Note is a better place for this sort of thing.

@rtoy
Copy link
Member

rtoy commented Apr 30, 2021

I think it was here: https://www.w3.org/2011/audio/audio-eq-cookbook.html . But looks like it immediately redirects to https://webaudio.github.io/Audio-EQ-Cookbook/audio-eq-cookbook.html now.

@rtoy rtoy added this to Untriaged in V1 via automation Apr 30, 2021
@rtoy
Copy link
Member

rtoy commented Apr 30, 2021

Should references to hr-time-2 be replaced by hr-time-3?

rtoy pushed a commit to rtoy/web-audio-api that referenced this issue Apr 30, 2021
This replaces the links to https://w3c.github.io/hr-time/ with
`[[hr-time-3]]`.  We also replaced all uses of `[[hr-time-2]]` with
`[[hr-time-3]]`.

Links to https://w3ctag.github.io/security-questionnaire/ have been
replaced with `[[security-privacy-questionnaire#]]`.

Finally, https://w3c.github.io/mediacapture-fromelement/ is replaced
by https://www.w3.org/TR/mediacapture-fromelement/.  (I don't know how
to get bikeshed to do that.)

The link to the Audio EQ cookbook is unchanged right now.
@svgeesus
Copy link
Contributor Author

svgeesus commented May 3, 2021

The table of contents for hr-time-3 is identical to that of hr-time-2 and there is no changes section.

However a diff shows new features like coarsen time and relative high resolution time so I guess it is more up to date. Do we use those new features?

@rtoy
Copy link
Member

rtoy commented May 3, 2021

Grepping for hr-time-2 shows just two uses, and they both talk about performance.now.

What should I do with the audio cookbook link? Change it to https://www.w3.org/2011/audio/audio-eq-cookbook.html even though it immediately redirects? I vaguely remember we asked Doug or you(?) to do the redirect because the original version was a little buggy.

@rtoy rtoy closed this as completed in e1d04b7 May 4, 2021
V1 automation moved this from Untriaged to Done May 4, 2021
@rtoy
Copy link
Member

rtoy commented May 10, 2021

F2F Meeting: We'll make the cookbook a W3C Note so there's a stable W3C link to it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
No open projects
V1
  
Done
Development

No branches or pull requests

3 participants