update docs

spicywebau · Apr 8, 2020 · 7bf9a22 · 7bf9a22
1 parent d0dd617
commit 7bf9a22
Show file tree

Hide file tree

Showing 2 changed files with 28 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -57,6 +57,7 @@ Neo copies/pastes a block with descendants, all descendant blocks are copied and
 - [Plugin Compatibility](docs/plugin-compatibility.md)
 - [FAQ](docs/faq.md)
 - [Content Migration Guide: Updating, Duplicating and Creating Block Types](docs/content-migration-guides/updating-duplicating-creating-block-types.md)
+- [Updating to Craft 3.4 and 2.7.x+](docs/craft3.4.md)
 - [Changelog](CHANGELOG.md)
 
 

diff --git a/docs/craft3.4.md b/docs/craft3.4.md
@@ -0,0 +1,27 @@
+# Updating to Craft 3.4 and 2.7.x+
+
+There are some steps required when updating to Craft 3.4 and neo 2.7.x+ from older versions. This is because craft 3.4 re-saves the entries before neo has a chance to add the database changes which throws an error when saving.
+
+## Steps
+
+1. Edit your composer.json.
+
+    Craft should be `3.4.0` and neo `2.6.5.1`. Your composer.json for craft and neo should look like this:
+    ```
+    "craftcms/cms": "3.4.0",
+    "spicyweb/craft-neo": "2.6.5.1",
+    ```
+
+2. Run the update command
+
+    Either `./craft update` or `composer update`
+
+3. Visit the CMS backend and let it run the migration/update
+
+4. Change your composer.json file back or like below:
+    ```
+    "craftcms/cms": "^3.4.0",
+    "spicyweb/craft-neo": "^2.6.5.1",
+    ```
+
+5. Rerun the update command.