WordPress / developer-blog-content

In this GitHub space, WordPress team coordinate content to be published on the Developer Blog. Discussion and montly meetings (first Thu) in WP Slack #core-dev-blog
36 stars 2 forks source link

How JSON schema versioning works and how it's different from the theme.json version #260

Open bph opened 2 months ago

bph commented 2 months ago

Discussed in https://github.com/WordPress/developer-blog-content/discussions/256

Originally posted by **juanmaguitar** May 1, 2024 Based on feedback like this one https://twitter.com/ChrisHufnagel/status/1784316768393052284 It would be useful for developers to have an additional explanation about how JSON schema versioning works and how it's different from the theme.json version. Such an article should cover IMO, at least the following ideas: - JSON Schemas for `block.json` and `theme.json` - The benefits of using a JSON Schema - Which JSON Schema version (which URL) should I use for my project? - What's the purpose of the `version` property in a `theme.json`? - What's the relationship (and differences) between the version of the JSON Schema and the version of the `theme.json`? - What's the purpose of the `version` property in a `block.json`? Is it related to the `version` property in a `theme.json`? @ajlende is on board about writing a post about this topic (see [this comment](https://github.com/WordPress/gutenberg/pull/58409#discussion_r1585148813)) > It's confused often enough that I'm planning on writing a developer.wordpress.org blog post to help explain how JSON schema versioning works and how it's different from the theme.json version.
ajlende commented 2 months ago

I'll be writing for this one 👍

bph commented 2 months ago

Thank you, @ajlende Here are three links for you

Please let me know how I can assist or if you have questions.

ajlende commented 6 days ago

Sorry this has been taking so long. There have been a few offshoots for other audiences as I was trying to keep this one more focused and short.

With those mostly out of the way, the Google Docs Draft is finally ready for the first round of reviews.

justintadlock commented 5 hours ago

Very well written, @ajlende! The first review is complete. I didn't have much to add, mostly just a few thoughts where things stood out to me while reading.