Doco updates (#1)

* Documentation Updates
Spruik · Aug 20, 2020 · fe6aba5 · fe6aba5
1 parent a58b4a4
commit fe6aba5
Show file tree

Hide file tree

Showing 13 changed files with 120 additions and 101 deletions.
diff --git a/.gitignore b/.gitignore
@@ -1,2 +1,4 @@
 /grafana/plugins
-/grafana/plugins/
+/grafana/plugins/
+tmp
+tmp/
diff --git a/README.md b/README.md
diff --git a/docs/equipment.png b/docs/equipment.png
diff --git a/docs/libre-line-performance.png b/docs/libre-line-performance.png
diff --git a/docs/libre-order-state-model.drawio b/docs/libre-order-state-model.drawio
@@ -0,0 +1 @@
+<mxfile host="Electron" modified="2020-08-20T15:21:34.592Z" agent="5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) draw.io/13.0.3 Chrome/80.0.3987.163 Electron/8.2.1 Safari/537.36" etag="hrPZ4yk3nCuzg_U7t5xm" version="13.0.3" type="device"><diagram name="Page-1" id="edf60f1a-56cd-e834-aa8a-f176f3a09ee4">7VtbU6MwFP41fdQBwq2Pa2t13Ms46+6qTzuxpMCakk5Ibeuv3wAJl2JLrLVFBx8czknOScg535dDMu2BwXR5QeEs+E48hHuG5i17YNgzDMfs8/+JYpUpTNPMFD4NvUylF4qb8BkJpSa089BDcaUjIwSzcFZVjkkUoTGr6CClZFHtNiG4OuoM+qimuBlDXNfehh4LhFbXtKLhEoV+IIZ2LdHwAMePPiXzSIzXM8Ak/cuap1D6Ev3jAHpkUVKB8x4YUEJY9jRdDhBOllYuW2Y32tCaz5uiiKkY2BpyNEe3nT7QAUD9EyAC9QTxHMl3SGfKVnJ1kMcXS4iEsoD4JIL4vNCepSuAkjE0LgVsivmjzh8xfED4LF+kAcGE8qaIRIlZzCBlIhssLqPI+5JEk4tjDOM4HP8KwihrGIVYOuVSyegfYmwlZDhnhKuKSX4jZCasYkbJYx7eRDMhERvBaYiTrP2DqAcjKNTCn5uOxujqTrxaKtwnwqklxeGy3DhcSWkZsjs5Y/5csuJSYZQI0qYeThHhmMzpWITj6/PvxQTdDgdXzj10/16iq+HziUQNpD5iW/qJ6CYhLQ0gkuUCkSni78A7CGSfaKe2bTuZ0aoKWoowZOFTFUJQINHPXeXer0nI36roQiaTmM+1lK78oTSJQpUm8csJvW0xSjk9oAgynqDrqb0IQoZuZjBd2wXntmr6VvM6B69KZu+WbBCHfpSkP08ARGW7mG/qhsNAjsXJZpT+5ZnzhChDy43csD3WktNEmK3+qWtnmkXBia7oFJTY0NQ2x74S2tfG0ajF8SeC3uqjR/HtodKd1sUK1GL1Ay1ZFyqj37pQdVv+jlu+sdueb6hs+ms78m5VgKFYBYAWbfpFHwkxt4oYt0CM9JIthLDb4iqvuze7ytaq5mpfpYhV38LmURRGfseMpt46ZrQ7Zmzbx5AKLzbynaXIn63mRWsNL87uvGhqx+ZFp4a0AZnOMGKoI0YLtI4Y3Y4YPyIxNhKepUigTquJsZnNVInRMo9NjP06MWISf/yjq7fTot2+AyqZ5B0vfjJedBR5sd9mXrTtvfGic/SCUa8f6l/DeUeMvfqHtA5awIz1s/uOGTcw46ljVchRkRqlnWBH/VDcqFoz6m26Wvzk5Fi/fenQtgltRgVtujLajDLatEOhTX/VGVdr0bZ2pKFru8Ot5ss8PN66KzR1vO24uR0FbcZnABtoPsRQxRpovot7b6jVb9A6qL0MNb0CtFJV2YS1yje2c7CPbKAINqMD26HA1l2A7rivqZaRRzrPUq4iW33Qb5r7qyINt9nXe6OtfgnaoW2vaKtWkQc7IVGtIlt9erwOEPsNX2xao6sNUOMpCVelbrOkQ/zCi8lJrx2FGgWqN06u32TCH7J5KKKfi8UvOrLuxa9mwPl/</diagram></mxfile>
diff --git a/docs/libre-order-state-model.png b/docs/libre-order-state-model.png
diff --git a/docs/product-operation.png b/docs/product-operation.png
diff --git a/docs/product.png b/docs/product.png
diff --git a/docs/raw-material.png b/docs/raw-material.png
diff --git a/docs/reason-codes.png b/docs/reason-codes.png
diff --git a/docs/scheduler-order-mgt-table-panel.gif b/docs/scheduler-order-mgt-table-panel.gif
diff --git a/docs/simulator.png b/docs/simulator.png
diff --git a/docs/try-it-out.md b/docs/try-it-out.md
@@ -28,21 +28,21 @@ Resolving deltas: 100% (49/49), done.
 
 ```shell
 $ docker-compose -f docker-compose.yml -f docker-compose.sim.yml up -d
-Creating network "libre-grafana_default" with the default driver
-Creating volume "libre-grafana_grafana_plugins" with default driver
-Creating volume "libre-grafana_grafana_provisioning" with default driver
-Creating volume "libre-grafana_postgres_data" with default driver
-Creating volume "libre-grafana_influx_data" with default driver
-Creating libre-grafana_influx_1   ... done
-Creating libre-grafana_postgres_1    ... done
-Recreating libre-grafana_simulator_1 ... done
-Creating libre-grafana_postREST_1    ... done
-Creating libre-grafana_grafana_1     ... done
+Creating network "libre_default" with the default driver
+Creating volume "libre_grafana_plugins" with default driver
+Creating volume "libre_grafana_provisioning" with default driver
+Creating volume "libre_postgres_data" with default driver
+Creating volume "libre_influx_data" with default driver
+Creating libre_influx_1   ... done
+Creating libre_postgres_1    ... done
+Creating libre_simulator_1   ... done
+Creating libre_postREST_1    ... done
+Creating libre_grafana_1     ... done
 
 ```
 
 3. Navigate to `https://localhost:3000` log into grafana with username admin and password admin. Explore the SmartFactory dashboard folder.
 
-4. Navigate to `https://localhost:3000` to start/stop and complete a line.
+4. Navigate to `https://localhost:1880/ui` to start/stop and complete a line.
 
-## Example
+![Simulation](simulator.png)
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		<mxfile host="Electron" modified="2020-08-20T15:21:34.592Z" agent="5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) draw.io/13.0.3 Chrome/80.0.3987.163 Electron/8.2.1 Safari/537.36" etag="hrPZ4yk3nCuzg_U7t5xm" version="13.0.3" type="device"><diagram name="Page-1" id="edf60f1a-56cd-e834-aa8a-f176f3a09ee4">7VtbU6MwFP41fdQBwq2Pa2t13Ms46+6qTzuxpMCakk5Ibeuv3wAJl2JLrLVFBx8czknOScg535dDMu2BwXR5QeEs+E48hHuG5i17YNgzDMfs8/+JYpUpTNPMFD4NvUylF4qb8BkJpSa089BDcaUjIwSzcFZVjkkUoTGr6CClZFHtNiG4OuoM+qimuBlDXNfehh4LhFbXtKLhEoV+IIZ2LdHwAMePPiXzSIzXM8Ak/cuap1D6Ev3jAHpkUVKB8x4YUEJY9jRdDhBOllYuW2Y32tCaz5uiiKkY2BpyNEe3nT7QAUD9EyAC9QTxHMl3SGfKVnJ1kMcXS4iEsoD4JIL4vNCepSuAkjE0LgVsivmjzh8xfED4LF+kAcGE8qaIRIlZzCBlIhssLqPI+5JEk4tjDOM4HP8KwihrGIVYOuVSyegfYmwlZDhnhKuKSX4jZCasYkbJYx7eRDMhERvBaYiTrP2DqAcjKNTCn5uOxujqTrxaKtwnwqklxeGy3DhcSWkZsjs5Y/5csuJSYZQI0qYeThHhmMzpWITj6/PvxQTdDgdXzj10/16iq+HziUQNpD5iW/qJ6CYhLQ0gkuUCkSni78A7CGSfaKe2bTuZ0aoKWoowZOFTFUJQINHPXeXer0nI36roQiaTmM+1lK78oTSJQpUm8csJvW0xSjk9oAgynqDrqb0IQoZuZjBd2wXntmr6VvM6B69KZu+WbBCHfpSkP08ARGW7mG/qhsNAjsXJZpT+5ZnzhChDy43csD3WktNEmK3+qWtnmkXBia7oFJTY0NQ2x74S2tfG0ajF8SeC3uqjR/HtodKd1sUK1GL1Ay1ZFyqj37pQdVv+jlu+sdueb6hs+ms78m5VgKFYBYAWbfpFHwkxt4oYt0CM9JIthLDb4iqvuze7ytaq5mpfpYhV38LmURRGfseMpt46ZrQ7Zmzbx5AKLzbynaXIn63mRWsNL87uvGhqx+ZFp4a0AZnOMGKoI0YLtI4Y3Y4YPyIxNhKepUigTquJsZnNVInRMo9NjP06MWISf/yjq7fTot2+AyqZ5B0vfjJedBR5sd9mXrTtvfGic/SCUa8f6l/DeUeMvfqHtA5awIz1s/uOGTcw46ljVchRkRqlnWBH/VDcqFoz6m26Wvzk5Fi/fenQtgltRgVtujLajDLatEOhTX/VGVdr0bZ2pKFru8Ot5ss8PN66KzR1vO24uR0FbcZnABtoPsRQxRpovot7b6jVb9A6qL0MNb0CtFJV2YS1yje2c7CPbKAINqMD26HA1l2A7rivqZaRRzrPUq4iW33Qb5r7qyINt9nXe6OtfgnaoW2vaKtWkQc7IVGtIlt9erwOEPsNX2xao6sNUOMpCVelbrOkQ/zCi8lJrx2FGgWqN06u32TCH7J5KKKfi8UvOrLuxa9mwPl/</diagram></mxfile>