Improve steps on how to migrate from an existing setup

VoiNetwork · Feb 3, 2024 · 0c187cc · 0c187cc
1 parent 8f64a77
commit 0c187cc
Show file tree

Hide file tree

Showing 3 changed files with 27 additions and 8 deletions.
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -17,4 +17,4 @@ repos:
   rev: v0.38.0
   hooks:
       - id: markdownlint-docker
-        args: ["--config", ".markdownlint.json"]
+        args: ["--config", ".markdownlint.json", "--disable", "MD046"]
diff --git a/docs/installation/installation.md b/docs/installation/installation.md
@@ -14,6 +14,10 @@ To set up a new Voi node, run the following command:
 
 ## Using an Existing Account/Address with Mnemonic
 
+!!! tip inline end
+    If you are migrating from an existing setup, and want to use the same account/mmenomic with Voi Swarm
+    this is the option for you.
+
 If you have an existing account/address with a mnemonic that you want to use, set the **VOINETWORK_IMPORT_ACCOUNT**
 environment variable to **1** and run the installation script:
 
@@ -22,6 +26,9 @@ export VOINETWORK_IMPORT_ACCOUNT=1
 /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/VoiNetwork/voi-swarm/main/install.sh)"
 ```
 
+???+ info
+    Post-installation steps for migrating from a D13 based setup can be [found here](../migrating.md)
+
 ## Installing Without Wallet Setup
 
 If you want to install without including wallet setup, set the **VOINETWORK_SKIP_WALLET_SETUP** environment variable to

diff --git a/docs/migrating.md b/docs/migrating.md
@@ -2,23 +2,35 @@
 
 ## From D13 based setups
 
-=== "Installing on same server"
+Install Voi Swarm on your server by importing your existing wallet using your mnemonic:
 
-    To help migrate from D13 based setups, there's a migration command available. This command will
+```bash
+export VOINETWORK_IMPORT_ACCOUNT=1
+/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/VoiNetwork/voi-swarm/main/install.sh)"
+```
 
-    1. Duplicate telemetry settings, including existing telemetry name and GUID, without affecting rewards.
-    2. Stop the host-based Voi service
-    3. Restart Voi Swarm
+=== "Installing on same server"
+
+    To migrate your setup on an existing server you must first install Voi Swarn on your server using the
+    [installation instructions](../installation/installation/#using-an-existing-accountaddress-with-mnemonic), after this
+    you can migrate your existing setup by running this command:
 
-    To run this command, you must [install Voi Swarm](../installation/installation/) first. Then run the following command:
 
     ```bash
     ~/voi/bin/migrate-from-d13-setup
     ```
 
+    This command will do the following steps for you:
+
+    1. Duplicate telemetry settings, including existing telemetry name and GUID, without affecting rewards.
+    2. Stop the host-based Voi service
+    3. Restart Voi Swarm
+
 === "Installing on a new server"
 
-    To migrate to a new server, you must first [install Voi Swarm](../installation/installation/) on the new server.
+    To migrate your setup to a new server you must first install Voi Swarm on the new server using the
+    [installation instructions](../installation/installation/#using-an-existing-accountaddress-with-mnemonic), after this
+    you can migrate your existing setup by following these steps:
 
     1. Run the following command on the old server to get the telemetry name and GUID: