From 467715dcb3ee23e05e8fe445d9e2a2416a26a8e0 Mon Sep 17 00:00:00 2001
From: LMBishop <13875753+LMBishop@users.noreply.github.com>
Date: Wed, 5 Jul 2023 20:54:36 +0100
Subject: Migrate docs to GitHub pages

---
 docs/tools/data-migration-tool.md | 35 +++++++++++++++++++++++++++++++++++
 1 file changed, 35 insertions(+)
 create mode 100644 docs/tools/data-migration-tool.md

(limited to 'docs/tools/data-migration-tool.md')

diff --git a/docs/tools/data-migration-tool.md b/docs/tools/data-migration-tool.md
new file mode 100644
index 00000000..891862c7
--- /dev/null
+++ b/docs/tools/data-migration-tool.md
@@ -0,0 +1,35 @@
+---
+title: Data migration tool
+parent: Tools
+---
+
+# Data migration tool
+
+The **data migration tool** is a tool that allows you to migrate your
+data from one [storage provider](Storage_providers "wikilink") to
+another. This can also be used as a backup tool. The tool can be
+accessed using `/quests admin migratedata`, which will generate a file
+[migrate_data.yml](https://github.com/LMBishop/Quests/blob/master/bukkit/src/main/resources/resources/bukkit/migrate_data.yml),
+where you must configure both providers.
+
+The `from` section is the configuration for the storage provider you are
+migrating from. The `to` section is the configuration for the storage
+provider you are migrating to. Both sections are required.
+
+When you have entered the information for both systems, you must set the
+`ready` flag to **true** at the end of the file. Then, to execute the
+migration, run the following command:
+
+     /quests admin migratedata execute
+
+  
+{: .warning }
+**It is advised that you do this process on a server with no players
+online.** You should set a whitelist, or turn on maintenence mode,
+before migrating data, and these commands should be done through your
+server console. Trying this process with players online may result in
+unexpected behaviour, or worse, potential data corruption!
+
+Once the migration has finished, you can safely delete migrate_data.yml.
+You may also want to manually update your main configuration to point to
+the new data provider.
-- 
cgit v1.2.3-70-g09d2