Use diff instead of js to mark a diff block

[OnkarRuikar]

Reported in https://github.com/orgs/mdn/discussions/158 (PR12)

[github-actions]

Preview URLs

• https://pr18477.content.dev.mdn.mozit.cloud/en-US/docs/Web/API/Web_Crypto_API/Non-cryptographic_uses_of_subtle_crypto

Flaws

None! 🎉

External URLs

URL: /en-US/docs/Web/API/Web_Crypto_API/Non-cryptographic_uses_of_subtle_crypto
Title: Non-cryptographic uses of SubtleCrypto
on GitHub

No new external URLs

(this comment was updated 2022-07-18 13:12:52.215469)

[Josh-Cena]

I think this actually denotes a "change" and using two code blocks makes it lose the point. What about changing the language to diff instead?

[OnkarRuikar]

What about changing the language to diff instead?

I think this will require a PR in yari to load diff along with other languages for the diff highlighting. And this is the only block in mdn/content that has diff. So it won't be worth it. 🤔

We can simply mark the block as text or plain though. @teoli2003 wdyt?

---

@teoli2003 deemed this as a case of "example-bad" vs "example-good".

This is an alternative to "example-bad" and "example-good", that we use everywhere else.

We are conveying the tampering in code comment. Instead of code comment we can have it outside the block.

[Josh-Cena]

diff is a super small component (605 bytes), so loading it is pretty low-cost. At worst we can live without syntax highlighting for this small code block, but I still think example-bad doesn't convey the idea of "tampering" clearly...

[OnkarRuikar]

diff is a super small component (605 bytes), so loading it is pretty low-cost.

But 'should we support diff blocks on mdn/content' will require a separate community discussion and some approvals.
I have no idea if this has been discussed in the past.

[teoli2003]

Yeah, let's put a diff, instead. You are right @Josh-Cena.

I think we should add glsl and diff to the prism syntaxes (but not webidl).

[OnkarRuikar]

I've reverted the changes and marked it as diff.

[teoli2003]

👍

[Josh-Cena]

should we support diff blocks on mdn/content

That made me a little upset. Content creation should not yield to the infrastructure. Infrastructure should adapt to content where possible. (e.g. I hold the same opinion about math equations.)

[teoli2003]

Yes, but we have to pay attention to complexity too. If the infrastructure is too complex, it is more likely to be less maintained and less stable. Dev resources are scarce, and we have to be sure to have infrastructure as light as possible (but not lighter).

[Josh-Cena]

I think I'll eventually help out on Yari as well, just so I can write my content better 😄 (As soon as I have the time...)