[Docs] adding upgrade guide

coreshop · Oct 25, 2024 · 36f7df1 · 36f7df1
1 parent 35e3655
commit 36f7df1
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 2 deletions.
diff --git a/docs/01_Getting_Started/02_Upgrade_Guide.md b/docs/01_Getting_Started/02_Upgrade_Guide.md
@@ -0,0 +1,14 @@
+# Upgrade Guide
+
+Please check the [Upgrade_Notes](02_Upgrade_Notes.md) Guide for changes and for potential breaking changes.
+
+We follow similar approach to updates as Pimcore does. So always update to the latest Minor release version first before 
+updating to the next Major release version. This means that if you are on 3.2.1 and want to update to 4.0, you should update
+to the latest 3.2.x release first and then update to 4.0 or 4.1.
+
+## Migration Files
+To keep things tidy, we remove migration between major versions. This means that if you are on 3.2.1 and you update to 4.0
+directly, you might miss migrations. Always update to the latest Minor release version first before updating to the next Major!
+
+This also means that if you do major updates, you will have old migrations in your Database. You can manually remove those
+if you want to keep your Migrations Table clean.
diff --git a/docs/01_Getting_Started/index.md b/docs/01_Getting_Started/index.md
@@ -5,5 +5,6 @@ This section provides a quick tutorial to get started with CoreShop. It covers t
 1. **Installation of Pimcore**: [Installation Guide](./00_Installation.md)
 2. **Architecture Overview**: [Architecture Overview](./01_Architecture_Overview.md)
 3. **Upgrade Notes**: [Upgrade Notes](./02_Upgrade_Notes.md)
-4. **UI Documentation**: [User Interface Documentation](../02_User_Documentation/index.md)
-5. **Developer Documentation**: [Developer Documentation](../03_Development/index.md)
+4. **Upgrade Guide**: [Upgrade Guide](02_Upgrade_Guide.md)
+5. **UI Documentation**: [User Interface Documentation](../02_User_Documentation/index.md)
+6. **Developer Documentation**: [Developer Documentation](../03_Development/index.md)