Discussion: Architecture and Sequence Diagrams

WebThings
#1

Hello WoT GW people,

I’ve been looking at the GW code for some time. I was wondering if anyone was thinking about providing some HLD documentation to how the GW works? This would help with getting up to speed for new dev’s.

An example of what I mean is here:

This is a similar project - so I’ve used as a comparison.
Is this something that the community is interested in?

Please reply to post if you do.

Kind regards, Nicholas

#2

Good pointer, and yes, I’m sure that would be quite helpful. Nicholas, do you have any interest in writing a first draft? Then the Mozilla wizards (who are busy working on finalizing the 0.4 release) can jump in to help.

#3

OK.

I’ll do a quick draft from what I’ve learned looking at the system on my Rapi’s. I’m still fairly fresh with Node.js and I’ve only just started learning the https://github.com/visionmedia/page.js router functions for the client side - so best i can do ATM :slight_smile: …

Do you want the ‘architecture’ page to be in the README.md here:


?

Thank you for your quick response!

Kind regards, Nicholas.

#4

Hi Kathy,

can you have a look at this please and provide feedback?

https://github.com/nherriot/gateway/tree/architecture

I’ve added a section at the front of the README.md to provide some high level architecture. Do you wish me to submit a pull request?

Kind regards, Nicholas.

#5

Wow, great start on the draft. Rather than replace the whole top level readme of the gateway, let’s start with adding this as a gateway-architecture-focused section in the wiki. There are technical and vocabulary nuances that I want to make sure are reviewed by the Mozilla team (very busy with the 0.4 release right now). Then we can clip sections out of the wiki (or the whole thing) and push into the top-level readme as appropriate.

#6

Hi Kathy,

No problem. In other projects what I’ve seen done is the /doc section holds README files for the whole system. So everything is updated and contained in the one place. We could do that - and just have a link to the ‘architecture’ README in /doc folder?

Anyway - can you point me to the Wiki? I had no idea there was one for the gateway!
Do you mean this? https://wiki.mozilla.org/MozIoT

Kind regards, Nicholas

#7

You can find the wiki on github here:

#8

When people get a chance, please review:

With a link on the main page:

Kind regards, Nicholas.

#9

The diagram is missing. The link on markdown points to 404.