From f9e1d8ea3d95dc170199ded552971176c7f7e123 Mon Sep 17 00:00:00 2001 From: Jason Cihelka Date: Mon, 22 May 2023 18:35:02 -0700 Subject: [PATCH] docs: add 2.0 to 2.1 migration guide --- docs/migration-v2.0-v2.1.md | 33 +++++++++++++++++++++++++++++++++ 1 file changed, 33 insertions(+) create mode 100644 docs/migration-v2.0-v2.1.md diff --git a/docs/migration-v2.0-v2.1.md b/docs/migration-v2.0-v2.1.md new file mode 100644 index 0000000..f30e0b0 --- /dev/null +++ b/docs/migration-v2.0-v2.1.md @@ -0,0 +1,33 @@ +# Migration Guide - V2.0 to V2.1 +This version results a very small breaking change in the `datasets.json` file. The `address` field is now parsed as an array/list, so you must enclose it in `[]` brackets. It does not need to contain multiple addresses, one will still work fine. + +This change allows one-many mapping between datasets and wallets, as may be the case when ingesting a dataset where the datacap allocation is split across multiple wallets. + +To change this, edit the `datasets.json` file: + + +OLD *~/.delta/importer/datasets.json* +```jsonc +[ + { + "dataset": "radiant-ml", + "address": "f1p3l3wgnfukemmaupqecwcoqp7fcgjcqgqcq7rja", + "dir": "/mnt/delta-datasets/radiant-poc", + "ignore": false + } +] +``` + +Change to: + +NEW *~/.delta/importer/datasets.json* +```jsonc +[ + { + "dataset": "radiant-ml", + "address": ["f1p3l3wgnfukemmaupqecwcoqp7fcgjcqgqcq7rja"], // <- address is now enclosed in [] brackets + "dir": "/mnt/delta-datasets/radiant-poc", + "ignore": false + } +] +``` \ No newline at end of file