From cf8ae810e878d92a473bffc5f2b02c99c91e0003 Mon Sep 17 00:00:00 2001
From: Michael Stenta <mike@mstenta.net>
Date: Sun, 27 Sep 2020 17:42:29 -0400
Subject: [PATCH] Document migration instructions.

---
 docs/migration/index.md | 22 ++++++++++++++++++++++
 mkdocs.yml              |  2 ++
 2 files changed, 24 insertions(+)
 create mode 100644 docs/migration/index.md

diff --git a/docs/migration/index.md b/docs/migration/index.md
new file mode 100644
index 00000000..8ecfceff
--- /dev/null
+++ b/docs/migration/index.md
@@ -0,0 +1,22 @@
+# Migrating from farmOS 1.x to 2.x
+
+1. Install farmOS 2.x.
+2. Install the farmOS modules you intend to use (this will determine what
+   data is migrated).
+3. Add farmOS 1.x database connection info to `settings.php`:
+
+        $databases['migrate']['default'] = [
+          'database' => 'my_farmos_1x_db',
+          'username' => 'my-db-username',
+          'password' => 'my-db-password',
+          'prefix' => '',
+          'host' => 'localhost',
+          'port' => '3306',
+          'namespace' => 'Drupal\\Core\\Database\\Driver\\mysql',
+          'driver' => 'mysql',
+        ];
+
+4. Install the farmOS Migrate (`farm_migrate`) module.
+5. Run the farmOS 1.x Migration via Drush:
+
+        drush migrate:import --group=farm_migrate
diff --git a/mkdocs.yml b/mkdocs.yml
index 286b03e8..24e70005 100644
--- a/mkdocs.yml
+++ b/mkdocs.yml
@@ -13,4 +13,6 @@ nav:
     - Debugging: development/debug.md
     - Automated tests: development/tests.md
     - Coding standards: development/code.md
+  - Migration:
+    - Overview: migration/index.md
 theme: readthedocs