Skip to content

Commit 7372ae8

Browse files
committed
docs: reword migration config readme
Signed-off-by: Gustavo Inacio <[email protected]>
1 parent 7e5d280 commit 7372ae8

File tree

1 file changed

+23
-7
lines changed

1 file changed

+23
-7
lines changed

docs/migration-config/README.md

Lines changed: 23 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,20 @@
11
# Migration guide
22

3-
In case you want to quickly migrate from the old stack into the new stack, you can use the following two configurations to help you to migrate without changing too much fields.
3+
In case you want to migrate from the old stack into the new
4+
stack quickly, you can use the following two configurations
5+
to help you migrate without changing too many fields.
46

5-
You just need to drop the config, use it in the `--config` args and add some additional environment variables.
7+
You just need to drop the config, use it in the `--config`
8+
args and add some additional environment variables.
69

7-
Please take a deeper look in the config, but 90% of the time you'll be safe just using it. If you find any issues using this config, feel free to open an issue.
10+
Please take a deeper look at the config, but 90% of the time
11+
you'll be safe just using it. If you find any issues using
12+
this config, feel free to open an issue.
813

914
## Missing configuration fields
1015

11-
The new stack requires you adding an escrow subgraph, similar to the current network subgraph field.
16+
The new stack requires adding an escrow subgraph,
17+
similar to the current network subgraph field.
1218

1319
You can edit the config yourself and add the following fields:
1420

@@ -25,10 +31,20 @@ INDEXER_SUBGRAPHS__ESCROW__QUERY_URL=<escrow subgraph query url>
2531
INDEXER_SUBGRAPHS__ESCROW__DEPLOYMENT_ID=<escrow deployment id>
2632
```
2733

28-
We recommend you migrating overtime to be fully in the configuration and don't need to provide multiple environment variables that can stay in plaintext, this will make your work easier.
34+
We recommend you migrate over time to be fully in the
35+
configuration and don't need to provide multiple environment
36+
variables that can stay in plaintext, this will make your work
37+
easier.
2938

3039
## Booleans inside config
3140

32-
The configuration doesn't accept booleans as strings, so in case you had `INDEXER_SERVICE_SERVE_NETWORK_SUBGRAPH` environment variable, please update to `INDEXER_SERVICE__SERVE_NETWORK_SUBGRAPH` and use `true/false` as values (or you could update directly in the configuration).
41+
The configuration doesn't accept booleans as strings, so in
42+
case you had `INDEXER_SERVICE_SERVE_NETWORK_SUBGRAPH` environment
43+
variable, please update to `INDEXER_SERVICE__SERVE_NETWORK_SUBGRAPH`
44+
and use `true/false` as values (or you could update directly in
45+
the configuration).
3346

34-
Please update the config accordingly. Also, check it out the explanation for each field in [config/minimal-config-example.toml](config/minimal-config-example.toml) and also [config/maximal-config-example.toml](config/maximal-config-example.toml)
47+
Please update the config accordingly. Also, check out the
48+
explanation for each field in
49+
[config/minimal-config-example.toml](config/minimal-config-example.toml)
50+
and also [config/maximal-config-example.toml](config/maximal-config-example.toml)

0 commit comments

Comments
 (0)