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

Replace all drafts.csswg.org spec_url with w3c.github.io/csswg-drafts URLs #17747

Merged
merged 3 commits into from
Sep 10, 2022

Conversation

sideshowbarker
Copy link
Collaborator

@sideshowbarker sideshowbarker commented Sep 10, 2022

Related browser-specs PR: w3c/browser-specs#704

If that browser-specs PR gets held up or blocked on objection, then I suggest we add our own downstream special-casing in our own tooling — which I’m happy to work on as part of this PR.

I imagine we could update our spec-URL-check tooling to just rewrite (in memory) all w3c.github.io/csswg-drafts to their drafts.csswg.org equivalents before doing the browser-specs check.

In fact maybe we should just go ahead and do that now — rather than waiting for the browser-specs PR to be merge — because as of today (as I write this) drafts.w3.org was down again just 15 hours ago, for the 2nd time in two days.

So if we make this update in BCD now, we can immediately (as soon as the changes propogate to production) give MDN users reliable links to CSS specs in our Specifications tables in MDN.

@github-actions github-actions bot added data:api 🐇 Compat data for Web APIs. https://developer.mozilla.org/docs/Web/API data:css 🎨 Compat data for CSS features. https://developer.mozilla.org/docs/Web/CSS data:html 📄 Compat data for HTML elements. https://developer.mozilla.org/docs/Web/HTML data:svg 🖌️ Compat data for SVG features. https://developer.mozilla.org/docs/Web/SVG linter 🏡 Issues or pull requests regarding the tests / linter of the JSON files. labels Sep 10, 2022
@sideshowbarker sideshowbarker force-pushed the sideshowbarker/drafts.csswg.org-spec-urls-replace branch from 2299419 to b538e2a Compare September 10, 2022 02:06
@sideshowbarker
Copy link
Collaborator Author

I imagine we could update our spec-URL-check tooling to just rewrite (in memory) all w3c.github.io/csswg-drafts to their drafts.csswg.org equivalents before doing the browser-specs check.

OK, I've now pushed an update here which does that. So CI is now all green here 🐍

Copy link
Collaborator

@queengooborg queengooborg left a comment

Choose a reason for hiding this comment

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

Thank you for this PR, I am definitely down for replacing all of the links to drafts.csswg.org to something more reliable, and I think that we should do this ASAP. (I have a sneaking suspicion that the browser-specs issue will be delayed as "the backend for drafts.csswg.org is being upgraded now"...) Let's get it merged!

@queengooborg queengooborg merged commit 085deec into main Sep 10, 2022
@queengooborg queengooborg deleted the sideshowbarker/drafts.csswg.org-spec-urls-replace branch September 10, 2022 03:24
@sideshowbarker
Copy link
Collaborator Author

🎉💜 Thanks much

@Elchi3
Copy link
Member

Elchi3 commented Sep 12, 2022

The test file says "When adding an exception here, provide a reason and indicate how the exception can be removed."
I think it would be nice also have a comment for this exception so that it is known why we derivate from browser-specs.

(The idea was that we don't derivate from browser-specs, because that repo makes decisions for us about what is the canonical source, so every exception should be documented).

@Elchi3
Copy link
Member

Elchi3 commented Sep 16, 2022

The downside of having exceptional spec_urls that are not in browser-specs is that we won't be able to gather spec metadata (like the title of a spec) for MDN spec tables. See mdn/content#20772 for how this breaks MDN CSS spec tables.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
data:api 🐇 Compat data for Web APIs. https://developer.mozilla.org/docs/Web/API data:css 🎨 Compat data for CSS features. https://developer.mozilla.org/docs/Web/CSS data:html 📄 Compat data for HTML elements. https://developer.mozilla.org/docs/Web/HTML data:svg 🖌️ Compat data for SVG features. https://developer.mozilla.org/docs/Web/SVG linter 🏡 Issues or pull requests regarding the tests / linter of the JSON files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants