Write a JSON Schema case study for the W3C Web of Things

[jviotti]

Fixes: json-schema-org/community#221
Fixes: w3c/wot-marketing#329
Signed-off-by: Juan Cruz Viotti [email protected]

[jviotti]

Hi @Relequestual and @egekorkan,

I'm opening this PR with what we have so far so that we can collaborate and get it out soon!

Some action items:

• We need a cover picture for the case study @egekorkan Do you have anything we could use?
• We need a round for review to see if there is anything we should change
• We need sign-off from the W3C WoT that this is fine to publish and no more corrections are needed
• We need to set the right publication date for the article

Thanks a lot!

[jviotti]

It doesn't seem like we will get a deployment preview of this branch for some reason. I'm attaching a PDF of how this looks like for me.

You can also locally see the case study by running the following commands:

$ git clone https://github.com/json-schema-org/blog
$ cd blog
$ yarn
$ yarn dev
# Open this post at http://localhost:8080/blog/posts/w3c-wot-case-study

How the W3C Web of Things brings JSON Schema to the Internet of Things | JSON Schema Blog.pdf

[egekorkan]

Hi @jviotti and @Relequestual ! Thanks for taking our input and turning it into a text that can be already read quite well. I can provide feedback, should I do it on the GitHub review or the PDF annotations? I would prefer GitHub option but I am ok for both. Regarding other points:

• Cover picture: We have the W3C WoT Logos at https://www.w3.org/WoT/IG/wiki/Web_of_Things_Logos but I am not sure if they would be good cover pictures. Otherwise, we have a cover picture at https://twitter.com/W3C_WoT . Another alternative would be that I can make a "WoT ❤️ JSON Schema" image using both logos?
• Regarding review process: As you have mentioned, we will need to give OK to publish, which is not a problem, the group has agreed that we want to do this. Just regarding the timeline, currently there will be some delays since I (and others too) am going on holidays for 2 weeks and then there are W3C events (W3C TPAC in Vancouver). I think that we can get it done before end of September though.

[jviotti]

@egekorkan Awesome! Please post any comments on GitHub. The PDF is just a rendering on my local environment to simplify showing it to you :)

Cover picture: We have the W3C WoT Logos at https://www.w3.org/WoT/IG/wiki/Web_of_Things_Logos but I am not sure if they would be good cover pictures. Otherwise, we have a cover picture at https://twitter.com/W3C_WoT . Another alternative would be that I can make a "WoT ❤️ JSON Schema" image using both logos?

The Twitter cover looks pretty neat IMO, as it's more hardware-ish, probably more than what I'd be able to create myself out of the two logos 😅 What do you think @Relequestual ?

[egekorkan]

actually "countering the fragmentation" is something we want to avoid since it starts with a negative tone. I would propose (from our input document):

Using JSON Schema at the W3C Web of Things to create an interoperability layer so that different IoT platforms, protocols and standards can operate together.

I hope it is not too late to fit into the small part that is under the title

[jviotti]

Makes sense! Done

[egekorkan]

abstraction of a physical entity can be understood differently by different people. Not sure of the best replacement but maybe "description of network-facing capabilities of physical entities"

[jviotti]

Yeah, I think that reads well. Done

[egekorkan]

Shouldn't we use another subject than "we"? There are other places with it as well.

[jviotti]

True. Other case studies use "We" only in quotations. I'll fix it everywhere

[jviotti]

Done

[jviotti]

I have added WoT's Twitter cover to the post. I think it looks pretty good:

[jviotti]

I have addressed all your comments @egekorkan . Please give it another round of review! I also added a "thank you" note at the end like for other case studies.

[egekorkan]

Thank you @jviotti ! Can you generate a new PDF so that I can send it for reviews in the WoT group?

[egekorkan]

Also, given that the cover picture was given to us by @Citrullin, @Citrullin is it fine to use it here (copyrights etc.)?

[handrews]

I just want to say I'm so happy to see this. I enjoyed meeting the WoT folks at their conference in Santa Clara several years ago, when we had just started to revive work on the JSON Schema spec. I'm really glad to see that the work we've done since then is of interest, and particularly excited to see how JSON Schema vocabularies can fit with Semantic Web approaches.

I never had as much time to keep up with the WoT work as I would have liked, but a better way to integrate with JSON LD/Semantic Web has always been something I'd love to see. I prioritized OAS integration in part because they had a major revision timed right for 2020-12, but the Thing Description has always been another major JSON Schema use case I kept in mind.

[egekorkan]

I just want to say I'm so happy to see this. I enjoyed meeting the WoT folks at their conference in Santa Clara several years ago, when we had just started to revive work on the JSON Schema spec. I'm really glad to see that the work we've done since then is of interest, and particularly excited to see how JSON Schema vocabularies can fit with Semantic Web approaches.

I never had as much time to keep up with the WoT work as I would have liked, but a better way to integrate with JSON LD/Semantic Web has always been something I'd love to see. I prioritized OAS integration in part because they had a major revision timed right for 2020-12, but the Thing Description has always been another major JSON Schema use case I kept in mind.

Thank you for all your support over the years! Maybe @sebastiankb can remember more from Santa Clara event but having one the authors of JSON Schema since the beginning was a big support :)

[jviotti]

@egekorkan Here you go!

How the W3C Web of Things brings JSON Schema to the Internet of Things | JSON Schema Blog.pdf

[egekorkan]

I have given it another read since forgetting about the text definitely helps ;) I will do another read next week

[jviotti]

Added!

[relu91]

Hey! sorry for being absent. I read the article and I liked a lot. Well done and thanks for your work :)

[egekorkan]

Here is my last feedback after reading for one last time. We did not receive any further feedback from the WG so this can be published once these small changes are done.

[jviotti]

Revisions accepted!

[egekorkan]

🥳

Let us know when the blog article is published. I have recently subscribed to the RSS feed and follow on Twitter but I can still miss it :)

[Relequestual]

I'm going to give it a final read through this week! =D

[Relequestual]

A few minor fixes, but the content is all good by me.
After tose are resolve, I say it's good to publish.

@egekorkan did you want to know when it will be published or just when it's published?
I'll probably merge in UK time, although anyone else is free to merge when my outstanding comments are resolved.

[egekorkan]

Thanks @Relequestual , I think the changes are good, just that there was a missing s for the last one. I cannot suggest changes on a suggested change so I had to create a new one.

@egekorkan did you want to know when it will be published or just when it's published?

Just when it is published :) I am not sure if the merge of this PR means publication, if it does, I will get the notification for sure :)

[jviotti]

All done! @Relequestual Don't forget to update the post date before publishing though