[mdn-compat-importer] Phase 1 modelisation "first stab"

Hi, folks!

Let’s plan a work session to see how we want the data to be structured.

This message is a report about what I pushed on GitHub for review [8].


Current situation

We currently have a JSON representation coming from MDN (!). 

Work is based on Frozenice’s mdn-compat-importer[9]. While working with the conversion, I tried to shape the data into something close to the work of Tobie and Ronald [6][7].

But it was impossible. It is mostly due to the data we currently have from MDN [0]. After discussing with Doug, I went to go toward a simpler design inspired by what he suggested (in this email [3]). 

With that in mind, I could work for a while, here is how each elements might look like [1]

It looks good. But there is still more to do.



What has been done

I basically created a topic branch [8] from frozenice's marvellous importer [0]. 

In this branch, I adjusted index.js and the Converter class to relay to a new Model[2] class.

You can see the result of its current work here [1].

I know it is not far, but I think it is worth showing.



What about the data model that was recently built?

I think with what we have from MDN [0] it is going to be hard to do “as-is”.

While I looked at both Tobie and Ronald’s model to replicate it, I got stuck by the lack of information we can currently have. Maybe because we would need to gather even more data.

In our context, I think we can only, at best, partially implement the model that was documented [6][7].

Maybe with [4][5]; it has to be figured out. 

Let’s see where the modelling goes in a work session.


Pat:

If you want to continue the work, you can use the fork in ‘internal-is-object’ where I built the full Vagrant/Salt VM managed with nvm, nodejs and everything else you could need. 

Instructions are in the README.vagrant.md file. You can also, of course, ping me on IRC.



More to come soon. 

  [0]: 1 element sample, raw from MDN into JSON: https://gist.github.com/renoirb/8746058#file-original-json
  [1]: 1 element sample, work in progress: https://gist.github.com/renoirb/8746058#file-converted-json
  [2]: https://github.com/webplatform/mdn-compat-importer/blob/internal-js-object/lib/Model.js
  [3]: http://www.w3.org/mid/5273F397.1010809@w3.org
  [4]: http://webplatform.github.io/browser-compat-model/#idl-def-Feature
  [5]: http://webplatform.github.io/browser-compat-model/#idl-def-SupportLevel
  [6]: http://webplatform.github.io/browser-compat-model/ 
  [7]: http://ronaldmansveld.github.io/webplatform-browser-compat/
  [8]: https://github.com/webplatform/mdn-compat-importer/tree/internal-js-object
  [9]: https://github.com/webplatform/mdn-compat-importer/

Regards,

Renoir
~