Skip to content

Commit 7015922

Browse files
authored
Merge pull request #1051 from FlowFuse/migration-guide-updates
Docs: Migration Guide updates
2 parents 81b0684 + d1f821f commit 7015922

File tree

7 files changed

+45
-28
lines changed

7 files changed

+45
-28
lines changed

docs/user/migration.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ description: Easily migrate from Dashboard 1.0 to 2.0 with this comprehensive gu
1111
import uiDropdown from './migration/ui_dropdown.json'
1212
import uiForm from './migration/ui_form.json'
1313
import uiGauge from './migration/ui_gauge.json'
14+
import uiLink from './migration/ui_link.json'
1415
import uiSlider from './migration/ui_slider.json'
1516
import uiSwitch from './migration/ui_switch.json'
1617
import uiTemplate from './migration/ui_template.json'
@@ -25,6 +26,7 @@ description: Easily migrate from Dashboard 1.0 to 2.0 with this comprehensive gu
2526
'ui_dropdown': uiDropdown,
2627
'ui_form': uiForm,
2728
'ui_gauge': uiGauge,
29+
'ui_link': uiLink,
2830
'ui_slider': uiSlider,
2931
'ui_switch': uiSwitch,
3032
'ui_template': uiTemplate,
@@ -59,7 +61,9 @@ Dashboard 2.0 will work alongside Dashboard 1.0, so you can start building your
5961

6062
### Migration Script
6163

62-
It is worth noting that we do have [plans](https://github.com/FlowFuse/node-red-dashboard/issues/261) to write some migrations scripts, that will take in a `flow.json` containing Dashboard 1.0 nodes, and output a `flow.json` containing Dashboard 2.0 nodes. However, this is not yet available, and will unlikely conduct a perfect 100% migration. Any thoughts, opinions and feedback on this idea are very welcome on the [GitHub issue](https://github.com/FlowFuse/node-red-dashboard/issues/261).
64+
We have a [Migration Service](https://flowfuse.com/product/dashboard/#migration-service) available to help you get started on moving your existing Dashboard 1.0 to Dashboard 2.0.
65+
66+
Whilst it will not migrate _everything_, it will give you a significant head start, and automate the majority of it for you. Anything that cannot be automatically migrated, are left in the flow, but disabled, so that they're flagged as requiring manual intervention.
6367

6468
## Dashboard 1.0 Nodes
6569

@@ -179,8 +183,6 @@ There has also been a [request](https://github.com/FlowFuse/node-red-dashboard/i
179183

180184
<MigrationWidgetProfile :profile="widgets['ui_link']" />
181185

182-
You can track progress of this development effort here: [Issue #387](https://github.com/FlowFuse/node-red-dashboard/issues/387)
183-
184186
### `ui_numeric`
185187

186188
Whilst this widget has no explicitly been transferred into Dashboard 2.0, the functionality is still available in the `ui-text-input` widget, where you can select the _"type"_ to be _"number"_.

docs/user/migration/ui_button.json

Lines changed: 12 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
{
22
"node": "ui_button",
3-
"description": "Button",
43
"properties": [
54
{
65
"property": "name",
@@ -24,8 +23,8 @@
2423
},
2524
{
2625
"property": "icon",
27-
"changes": -1,
28-
"notes": "<a href='https://github.com/FlowFuse/node-red-dashboard/issues/322' target='_blank'>Issue #322</a>"
26+
"changes": null,
27+
"notes": null
2928
},
3029
{
3130
"property": "tooltip",
@@ -54,8 +53,8 @@
5453
},
5554
{
5655
"property": "emulate click",
57-
"changes": -1,
58-
"notes": "<a href='https://github.com/FlowFuse/node-red-dashboard/issues/209' target='_blank'>Issue #209</a>"
56+
"changes": null,
57+
"notes": null
5958
},
6059
{
6160
"property": "class",
@@ -66,23 +65,23 @@
6665
"msgs": [
6766
{
6867
"property": "label",
69-
"changes": -1,
70-
"notes": "<a href='https://github.com/FlowFuse/node-red-dashboard/issues/376' target='_blank'>Issue #376</a>"
68+
"changes": null,
69+
"notes": null
7170
},
7271
{
7372
"property": "icon",
74-
"changes": -1,
75-
"notes": "<a href='https://github.com/FlowFuse/node-red-dashboard/issues/376' target='_blank'>Issue #376</a>"
73+
"changes": null,
74+
"notes": null
7675
},
7776
{
7877
"property": "enabled/disabled",
79-
"changes": -1,
80-
"notes": "<a href='https://github.com/FlowFuse/node-red-dashboard/issues/352' target='_blank'>Issue #352</a>"
78+
"changes": null,
79+
"notes": null
8180
},
8281
{
8382
"property": "visible/hidden",
84-
"changes": -1,
85-
"notes": "<a href='https://github.com/FlowFuse/node-red-dashboard/issues/377' target='_blank'>Issue #377</a>"
83+
"changes": null,
84+
"notes": null
8685
}
8786
]
8887
}

docs/user/migration/ui_chart.json

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
{
22
"node": "ui_chart",
3-
"description": "Chart stuff",
43
"properties": [
54
{
65
"property": "name",
@@ -49,8 +48,8 @@
4948
},
5049
{
5150
"property": "x-axis label",
52-
"changes": -1,
53-
"notes": "<a href='https://github.com/FlowFuse/node-red-dashboard/issues/382' target='_blank'>Issue #382</a>"
51+
"changes": null,
52+
"notes": null
5453
},
5554
{
5655
"property": "y-axis min/max",

docs/user/migration/ui_dropdown.json

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
{
22
"node": "ui_dropdown",
3-
"description": "Dropdown",
43
"properties": [
54
{
65
"property": "name",
@@ -29,8 +28,8 @@
2928
},
3029
{
3130
"property": "placeholder",
32-
"changes": -1,
33-
"notes": "<a href='https://github.com/FlowFuse/node-red-dashboard/issues/386' target='_blank'>Issue #386</a>"
31+
"changes": "merged",
32+
"notes": "Combined with 'label' property in new design"
3433
},
3534
{
3635
"property": "options",

docs/user/migration/ui_form.json

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
{
22
"node": "ui_form",
3-
"description": "Form stuff",
43
"properties": [
54
{
65
"property": "name",
@@ -62,13 +61,13 @@
6261
"msgs": [
6362
{
6463
"property": "msg.properties",
65-
"changes": -1,
66-
"notes": "<a target='_blank' href='https://github.com/FlowFuse/node-red-dashboard/issues/287'>Issue #287</a>"
64+
"changes": "changed",
65+
"notes": "Now <code>msg.ui_update.options</code>."
6766
},
6867
{
6968
"property": "msg.payload",
70-
"changes": -1,
71-
"notes": "<a target='_blank' href='https://github.com/FlowFuse/node-red-dashboard/issues/363'>Issue #363</a>"
69+
"changes": null,
70+
"notes": null
7271
}
7372
]
7473
}

docs/user/migration/ui_link.json

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
{
2+
"node": "ui_button",
3+
"properties": [
4+
{
5+
"property": "name",
6+
"changes": null,
7+
"notes": null
8+
},
9+
{
10+
"property": "path",
11+
"changes": null,
12+
"notes": null
13+
},
14+
{
15+
"property": "icon",
16+
"changes": null,
17+
"notes": null
18+
}
19+
]
20+
}

docs/user/migration/ui_slider.json

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
{
22
"node": "ui_slider",
3-
"description": "Slider stuff",
43
"properties": [
54
{
65
"property": "name",

0 commit comments

Comments
 (0)