Merge pull request #100 from mozilla-services/add-sync-flow-diagram

Added synchronization flow diagram.

docs/api.md

@@ -196,6 +196,8 @@ Result:
 
 Synchronizing local data with remote ones is performed by calling the `#sync()` method.
 
+![](images/sync-flow.png)
+
 Synopsis:
 
 1. Fetch remote changes since last synchronization;

docs/src/sync-flow.xml

@@ -0,0 +1,2 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<mxGraphModel dx="1434" dy="776" grid="1" gridSize="10" guides="1" tooltips="1" connect="1" fold="1" page="1" pageScale="1" pageWidth="826" pageHeight="1169" style="default-style2" math="0"><root><mxCell id="0"/><mxCell id="1" parent="0"/><mxCell id="2" value="sync()" style="whiteSpace=wrap;html=1;strokeWidth=2;blue;rounded=1;" parent="1" vertex="1"><mxGeometry x="230" y="30" width="120" height="60" as="geometry"/></mxCell><mxCell id="3" value="First time?&lt;br&gt;" style="rhombus;whiteSpace=wrap;html=1;strokeWidth=2;yellow" parent="1" vertex="1"><mxGeometry x="250" y="120" width="80" height="80" as="geometry"/></mxCell><mxCell id="8" style="edgeStyle=orthogonalEdgeStyle;rounded=0;html=1;exitX=0.5;exitY=1;entryX=0.5;entryY=0;shadow=1;strokeWidth=2;" parent="1" source="2" target="3" edge="1"><mxGeometry relative="1" as="geometry"/></mxCell><mxCell id="9" value="Fetch everything&lt;br&gt;" style="whiteSpace=wrap;html=1;strokeWidth=2;green;rounded=1;" parent="1" vertex="1"><mxGeometry x="70" y="130" width="120" height="60" as="geometry"/></mxCell><mxCell id="10" value="Fetch latest changes&lt;br&gt;" style="whiteSpace=wrap;html=1;strokeWidth=2;green;rounded=1;" parent="1" vertex="1"><mxGeometry x="390" y="130" width="120" height="60" as="geometry"/></mxCell><mxCell id="12" value="&lt;font style=&quot;font-size: 12px&quot;&gt;no&lt;/font&gt;" style="edgeStyle=orthogonalEdgeStyle;rounded=0;html=1;exitX=1;exitY=0.5;entryX=0;entryY=0.5;shadow=1;strokeWidth=2;" parent="1" source="3" target="10" edge="1"><mxGeometry relative="1" as="geometry"/></mxCell><mxCell id="14" value="Import changes&lt;br&gt;&amp;nbsp;into local database&lt;br&gt;" style="whiteSpace=wrap;html=1;strokeWidth=2;green;rounded=1;" parent="1" vertex="1"><mxGeometry x="230" y="230" width="120" height="60" as="geometry"/></mxCell><mxCell id="15" style="edgeStyle=orthogonalEdgeStyle;rounded=0;html=1;exitX=0.5;exitY=1;entryX=0;entryY=0.5;shadow=1;strokeWidth=2;" parent="1" source="9" target="14" edge="1"><mxGeometry relative="1" as="geometry"/></mxCell><mxCell id="16" style="edgeStyle=orthogonalEdgeStyle;rounded=0;html=1;exitX=0.5;exitY=1;entryX=1;entryY=0.5;shadow=1;strokeWidth=2;" parent="1" source="10" target="14" edge="1"><mxGeometry relative="1" as="geometry"/></mxCell><mxCell id="17" value="Conflicts?" style="rhombus;whiteSpace=wrap;html=1;strokeWidth=2;yellow" parent="1" vertex="1"><mxGeometry x="250" y="320" width="80" height="80" as="geometry"/></mxCell><mxCell id="18" style="edgeStyle=orthogonalEdgeStyle;rounded=0;html=1;exitX=0.5;exitY=1;entryX=0.5;entryY=0;shadow=1;strokeWidth=2;" parent="1" source="14" target="17" edge="1"><mxGeometry relative="1" as="geometry"/></mxCell><mxCell id="19" value="Handle import conflicts&lt;br&gt;" style="whiteSpace=wrap;html=1;strokeWidth=2;red;rounded=1;" parent="1" vertex="1"><mxGeometry x="390" y="330" width="120" height="60" as="geometry"/></mxCell><mxCell id="22" value="Publish local changes&lt;br&gt;&amp;nbsp;to remote server&lt;br&gt;" style="whiteSpace=wrap;html=1;strokeWidth=2;green;rounded=1;" parent="1" vertex="1"><mxGeometry x="230" y="440" width="120" height="60" as="geometry"/></mxCell><mxCell id="23" value="no" style="edgeStyle=orthogonalEdgeStyle;rounded=0;html=1;exitX=0.5;exitY=1;entryX=0.5;entryY=0;shadow=1;strokeWidth=2;" parent="1" source="17" target="22" edge="1"><mxGeometry relative="1" as="geometry"/></mxCell><mxCell id="25" value="yes&lt;br&gt;" style="edgeStyle=orthogonalEdgeStyle;rounded=0;html=1;exitX=0;exitY=0.5;entryX=1;entryY=0.5;shadow=1;strokeWidth=2;" parent="1" source="3" target="9" edge="1"><mxGeometry relative="1" as="geometry"/></mxCell><mxCell id="33" value="Conflicts?" style="rhombus;whiteSpace=wrap;html=1;strokeWidth=2;yellow" parent="1" vertex="1"><mxGeometry x="250" y="530" width="80" height="80" as="geometry"/></mxCell><mxCell id="34" value="Handle export conflicts&lt;br&gt;" style="whiteSpace=wrap;html=1;strokeWidth=2;red;rounded=1;" parent="1" vertex="1"><mxGeometry x="390" y="540" width="120" height="60" as="geometry"/></mxCell><mxCell id="41" style="edgeStyle=orthogonalEdgeStyle;rounded=0;html=1;exitX=0.5;exitY=1;entryX=0.5;entryY=0;shadow=1;strokeWidth=2;" parent="1" source="22" target="33" edge="1"><mxGeometry relative="1" as="geometry"/></mxCell><mxCell id="42" value="Fetch latest changes&lt;br&gt;" style="whiteSpace=wrap;html=1;strokeWidth=2;green;rounded=1;" parent="1" vertex="1"><mxGeometry x="230" y="640" width="120" height="60" as="geometry"/></mxCell><mxCell id="44" value="no" style="edgeStyle=orthogonalEdgeStyle;rounded=0;html=1;exitX=0.5;exitY=1;entryX=0.5;entryY=0;shadow=1;strokeWidth=2;" parent="1" source="33" target="42" edge="1"><mxGeometry relative="1" as="geometry"/></mxCell><mxCell id="45" value="Conflicts?" style="rhombus;whiteSpace=wrap;html=1;strokeWidth=2;yellow" parent="1" vertex="1"><mxGeometry x="250" y="730" width="80" height="80" as="geometry"/></mxCell><mxCell id="47" value="Handle import conflicts&lt;br&gt;" style="whiteSpace=wrap;html=1;strokeWidth=2;red;rounded=1;" parent="1" vertex="1"><mxGeometry x="390" y="740" width="120" height="60" as="geometry"/></mxCell><mxCell id="51" value="Expose synchronisation report&lt;br&gt;" style="whiteSpace=wrap;html=1;strokeWidth=2;blue;rounded=1;" parent="1" vertex="1"><mxGeometry x="560" y="740" width="120" height="60" as="geometry"/></mxCell><mxCell id="54" value="yes" style="edgeStyle=orthogonalEdgeStyle;rounded=0;html=1;exitX=1;exitY=0.5;entryX=0;entryY=0.5;shadow=1;strokeWidth=2;" parent="1" source="17" target="19" edge="1"><mxGeometry relative="1" as="geometry"/></mxCell><mxCell id="55" value="yes" style="edgeStyle=orthogonalEdgeStyle;rounded=0;html=1;exitX=1;exitY=0.5;entryX=0;entryY=0.5;shadow=1;strokeWidth=2;" parent="1" source="33" target="34" edge="1"><mxGeometry relative="1" as="geometry"/></mxCell><mxCell id="56" style="edgeStyle=orthogonalEdgeStyle;rounded=0;html=1;exitX=1;exitY=0.5;entryX=0.75;entryY=0;shadow=1;strokeWidth=2;" parent="1" source="19" target="51" edge="1"><mxGeometry relative="1" as="geometry"/></mxCell><mxCell id="57" style="edgeStyle=orthogonalEdgeStyle;rounded=0;html=1;exitX=0.5;exitY=1;entryX=0.25;entryY=0;shadow=1;strokeWidth=2;" parent="1" source="34" target="51" edge="1"><mxGeometry relative="1" as="geometry"/></mxCell><mxCell id="59" style="edgeStyle=orthogonalEdgeStyle;rounded=0;html=1;exitX=0.5;exitY=1;entryX=0.5;entryY=0;shadow=1;strokeWidth=2;" parent="1" source="42" target="45" edge="1"><mxGeometry relative="1" as="geometry"/></mxCell><mxCell id="65" value="yes" style="edgeStyle=orthogonalEdgeStyle;rounded=0;html=1;exitX=1;exitY=0.5;entryX=0;entryY=0.5;shadow=1;strokeWidth=2;" parent="1" source="45" target="47" edge="1"><mxGeometry relative="1" as="geometry"/></mxCell><mxCell id="66" style="edgeStyle=orthogonalEdgeStyle;rounded=0;html=1;exitX=1;exitY=0.5;entryX=0;entryY=0.5;shadow=1;strokeWidth=2;" parent="1" source="47" target="51" edge="1"><mxGeometry relative="1" as="geometry"/></mxCell><mxCell id="67" value="no" style="edgeStyle=orthogonalEdgeStyle;rounded=0;html=1;exitX=0.5;exitY=1;entryX=0.5;entryY=1;strokeWidth=2;shadow=1;" parent="1" source="45" target="51" edge="1"><mxGeometry relative="1" as="geometry"><Array as="points"><mxPoint x="290" y="830"/><mxPoint x="620" y="830"/></Array></mxGeometry></mxCell><mxCell id="69" style="edgeStyle=orthogonalEdgeStyle;rounded=0;html=1;exitX=1;exitY=0.5;entryX=1;entryY=0.5;shadow=1;strokeWidth=2;dashed=1;" parent="1" source="51" target="2" edge="1"><mxGeometry relative="1" as="geometry"><Array as="points"><mxPoint x="710" y="770"/><mxPoint x="710" y="60"/></Array></mxGeometry></mxCell></root></mxGraphModel>