docs: add migration guide

ly525 · 小小鲁班
1 parent c879cfdf
Showing 5 changed files with 64 additions and 0 deletions
docs/.vuepress/config.js
docs/en/migration-guide/README.md
docs/en/migration-guide/migration-guide-1.8.0-to-1.8.1.md
docs/zh/migration-guide/README.md
docs/zh/migration-guide/migration-guide-1.8.0-to-1.8.1.md
@@ -65,6 +65,13 @@ module.exports = {
                 '/en/plugin-development/quick-start',
               ],
             },
+            {
+              collapsable: false,
+              title: 'Migrating',
+              children: [
+                '/en/migration-guide/',
+              ],
+            },
           ],
         },
       },
@@ -108,6 +115,13 @@ module.exports = {
                 '/zh/plugin-development/quick-start',
               ],
             },
+            {
+              collapsable: false,
+              title: '迁移',
+              children: [
+                '/zh/migration-guide/',
+              ],
+            },
           ],
         },
       },
+# Migrations guides
+
+- [Migration guide from v.1.8.0 to v1.8.1](migration-guide-1.8.0-to-1.8.1.md)
 \ No newline at end of file
+# Migration guide from v.1.8.0 to v.1.8.1
+Upgrading your Luban-H5 application to `v.1.8.1`.
+
+Here are the patch changes:
+- upgrade the strapi version from beta.17.x to beta.18.4 to fix [/upload return the url contains `localhost:1337` after migrate from beta.13 to beta.17.8](https://github.com/strapi/strapi/issues/4791)
+
+- see more here: [Strapi Migration guide from beta.17+ to beta.18](https://strapi.io/documentation/3.0.0-beta.x/migration-guide/migration-guide-beta.17-to-beta.18.html)
+
+
+To upgrade a project to the `v.1.8.1` version of Luban-H5 follow the instructions below.
+
+```bash
+# clone the newest code
+# clean the h5-api cache, node_modules and admin panel
+# !! and this step will stop the api service(it will run the `./luban-h5 stop` firstly)
+./luban-h5 clean
+# reinstall the dependencies and rebuild the admin panel
+./luban-h5 init
+./luban-h5 start
+```
+
+feel free open an [issue](https://github.com/ly525/luban-h5/issues) if you have questions about this.
 \ No newline at end of file
+# 迁移指南
+
+- [v.1.8.0 至 v.1.8.1 迁移指南](migration-guide-1.8.0-to-1.8.1.md)
 \ No newline at end of file
+# 鲁班H5 v.1.8.0 至 v.1.8.1 迁移指南
+升级`鲁班H5`版本至 `v.1.8.1`.
+
+主要修改是：
+- 将 strapi依赖从 beta.17.x 升级至 beta.18.4， 主要为了修复 [图片上传之后，返回的response url 中包含 localhost:1337](https://github.com/strapi/strapi/issues/4791)
+
+- 更多请参见 Strapi 升级指南: [Strapi Migration guide from beta.17+ to beta.18](https://strapi.io/documentation/3.0.0-beta.x/migration-guide/migration-guide-beta.17-to-beta.18.html)
+
+
+将 鲁班H5 升级到`v.1.8.1` 比较简单，只要执行如下命令即可：
+
+```bash
+# clone 最新代码
+# 删除后端相关的缓存、admin后台、node_modules
+# !! 注意下面的命令会先停止服务
+./luban-h5 clean
+# 重新安装依赖，构建admin后台
+./luban-h5 init
+./luban-h5 start
+```
+
+如果有疑问，提 [issue](https://github.com/ly525/luban-h5/issues) 即可
 \ No newline at end of file