Replace manual spec tables with specifications macro #13126
Comments
github-actions
bot
added
the
needs triage
queengooborg
added
the
bulk update
|
I'll help with this, but not until mdn/yari#5284 (comment) is answered. We probably need to make it clear that BCD is still the desired option, if possible. |
sideshowbarker
removed
the
needs triage
|
This weekend I played around with automating this, and I have a reproducible working solution — based on a hack to the https://github.com/mdn/yari/blob/main/markdown/cli.ts source. So I’ve gone ahead and assigned this to myself as a heads-up to preempt duplication of effort. One side effect of the automation is that it causes redundant spaces to get reduced to a single space. I think that’s an expected consequence of the fact that what I’m doing is, first running In other words, it’s I guess it’s not a bad thing to zap all those extra spaces — but the problem is, it makes it harder to wade through the diffs to review the actual So I think, to create the PRs, I’ll do some that first just make the whitespace changes — and then after those are merged, I can run the conversion that’ll give us just the |
Nevermind – after spending some more time thinking about it, I realized I could do some git gymnastics: the first commit with the unrelated (whitespace, etc.) changes, and then a second commit with the actual spec-URL changes we care about — and then rebasing and deleting the first commit. #13170 is the result. So at this point, I’ll stop and write up the steps I used for doing the conversion, and clean up my https://github.com/mdn/yari/blob/main/markdown/cli.ts hack and open a yari PR with the patch — not because we’ll necessarily want to ever merge that into yari, but instead so that anybody else interested could try it out locally themselves. |
|
mdn/yari#5309 has the modification I made to the |
|
Note that web/http has a lot of Unknown specification due to RFCs not in browser-specs (and some are Webdav). |
Yup — see my comment over at #13170 (comment). I think this part may be pretty easy to solve. Anyway, I’ll soon have something we can try out for it, at least. |
queengooborg
added
the
good first issue
* Add spec URLs for the web/http subtree Part of #13126 * Fix some cases that should be using the browser-compat frontmatter key * Add some missing RFCs to SpecData.json Previously we didn’t need these in SpecData.json because the RFC macro doesn’t actually do any title lookup.
* Add spec URLs for the web/svg subtree Part of #13126 * Drop browser-compat for SVG cases not actually in BCD; add spec-urls instead * Fix browser-compat for “by”, “spreadMethod” & “vector-effect” Related: mdn/browser-compat-data#15141
* Add spec URLs for web/accessibility subtree Part of #13126 * Add the Living version of ARIA Authoring Practices to SpecData.json Otherwise, without this change, the spec-urls values being added for the ARIA Authoring Practices guide get shown with “Unknown specification” in output.
* Add spec URLs for the web/http subtree Part of mdn#13126 * Fix some cases that should be using the browser-compat frontmatter key * Add some missing RFCs to SpecData.json Previously we didn’t need these in SpecData.json because the RFC macro doesn’t actually do any title lookup.
* Add spec URLs for the web/svg subtree Part of mdn#13126 * Drop browser-compat for SVG cases not actually in BCD; add spec-urls instead * Fix browser-compat for “by”, “spreadMethod” & “vector-effect” Related: mdn/browser-compat-data#15141
* Add spec URLs for web/accessibility subtree Part of mdn#13126 * Add the Living version of ARIA Authoring Practices to SpecData.json Otherwise, without this change, the spec-urls values being added for the ARIA Authoring Practices guide get shown with “Unknown specification” in output.
|
As far as I can tell, this is completed. But if I’ve missed anything, please let me know |
Now that mdn/yari#5284 has landed, we can take advantage of the
{{Specifications}}macro for entries that are not present in BCD. We should convert all of our spec tables to the macro, either by linking to BCD where able or adding thespec-urlskey to the page metadata.Breakdown of all files seemingly containing a manual spec table (found with
rg -i '\| Specification|Specification', last updated May 14, 2022):The text was updated successfully, but these errors were encountered: