This is an automated email from the ASF dual-hosted git repository.
benjobs pushed a commit to branch dev
in repository
https://gitbox.apache.org/repos/asf/incubator-streampark-website.git
The following commit(s) were added to refs/heads/dev by this push:
new 9035835b [improve] add upgrade process part doc (#340)
9035835b is described below
commit 9035835bcd65941c555c764ea5bc8d5933af2850
Author: VampireAchao <[email protected]>
AuthorDate: Tue Mar 19 10:42:03 2024 +0800
[improve] add upgrade process part doc (#340)
* [improve] add upgrade process part doc
* Revert "[improve] add upgrade process part doc"
This reverts commit ff11c11dd37c8aedfdee329c628a05c2531d9d48.
* [improve] add Version Upgrade Guide doc
---
docs/user-guide/13-version-upgrade.md | 69 ++++++++++++++++++++++
.../current/user-guide/13-version-upgrade.md | 67 +++++++++++++++++++++
2 files changed, 136 insertions(+)
diff --git a/docs/user-guide/13-version-upgrade.md
b/docs/user-guide/13-version-upgrade.md
new file mode 100644
index 00000000..7e6383fe
--- /dev/null
+++ b/docs/user-guide/13-version-upgrade.md
@@ -0,0 +1,69 @@
+---
+id: 'version-upgrade'
+title: 'Version Upgrade Guide'
+sidebar_position: 13
+---
+
+### Pre-Upgrade Preparation
+
+Before starting the upgrade process, please ensure the following preparatory
steps are completed to ensure a smooth transition.
+
+- **Database Backup**: An essential step to ensure you have a complete backup
of your database. This allows for recovery to the pre-upgrade state if any
problems are encountered during the upgrade.
+- **Check Version Compatibility**: Confirm your current version number and
ensure that the upgrade path is compatible with your version. This guide is
applicable for upgrades starting from version `1.2.3`.
+- **Verify System Requirements**: Ensure that your server meets the system
requirements for the new version.
+
+### Locating Upgrade Scripts
+
+Upgrade scripts are located in the `script/upgrade` directory. You will need
to choose the correct script based on your current version and the target
version for the upgrade.
+
+```plaintext
+script
+└── upgrade
+ ├── mysql
+ | ├── 1.2.3.sql
+ | ├── 2.0.0.sql
+ | ├── 2.1.0.sql
+ | └── 2.1.2.sql
+ └── pgsql
+ ├── 2.1.0.sql
+ ├── 2.1.2.sql
+ └── 2.1.3.sql
+```
+
+### Executing Upgrade Scripts
+
+Connect to your database using a database management tool (such as MySQL
Workbench, pgAdmin, JetBrains DataGrip) and execute the upgrade scripts
sequentially.
+
+####
+
+#### Example: Upgrading from 2.0.0 to 2.1.2
+
+1. **Upgrade to 2.1.0**:
+
+```bash
+# Use command line or your database management tool to execute the 2.1.0.sql
script
+mysql -h 127.0.0.1 -P 3306 -u root --password=streampark streampark <
./script/upgrade/mysql/2.1.0.sql
+```
+
+2. **Upgrade to 2.1.2**:
+
+```bash
+# Next, execute the 2.1.2.sql script to complete the upgrade
+mysql -h 127.0.0.1 -P 3306 -u root --password=streampark streampark <
./script/upgrade/mysql/2.1.2.sql
+```
+
+### Verifying the Upgrade
+
+After completing the upgrade, log into your application and check that
everything is running normally. You can review the application logs or verify
that new version features are working as expected.
+
+### Troubleshooting
+
+If you encounter any issues during the upgrade process:
+
+1. **Refer to Official Documentation**: Look for possible error messages and
solutions.
+2. **Restore Backup**: If the upgrade fails, restore your database to its
pre-upgrade state using the backup created earlier.
+3. **Seek Help**: If the problem persists, seek assistance through Apache
StreamPark's official forum or community.
+
+### Next Steps
+
+After the upgrade is complete, you may need to adjust and optimize your
application's configuration and performance settings based on the features and
improvements of the new version.
diff --git
a/i18n/zh-CN/docusaurus-plugin-content-docs/current/user-guide/13-version-upgrade.md
b/i18n/zh-CN/docusaurus-plugin-content-docs/current/user-guide/13-version-upgrade.md
new file mode 100644
index 00000000..75962d12
--- /dev/null
+++
b/i18n/zh-CN/docusaurus-plugin-content-docs/current/user-guide/13-version-upgrade.md
@@ -0,0 +1,67 @@
+---
+id: 'version-upgrade'
+title: '版本升级指南'
+sidebar_position: 13
+---
+
+### 升级前准备
+
+在开始升级之前，请确保已完成以下准备工作，以确保升级过程顺利进行。
+
+- **备份数据库**：非常重要的一步，确保有完整的数据库备份，以便在升级过程中遇到问题时可以恢复到升级前的状态。
+- **检查版本兼容性**：确认当前的版本号，并确保升级路径与您的版本兼容。本指南适用于从 `1.2.3` 版本开始的升级。
+- **确认环境要求**：确保您的服务器满足新版本的系统要求。
+
+### 找到升级脚本
+
+升级脚本位于 `script/upgrade` 目录。您需要根据当前版本和目标版本选择正确的脚本进行升级。
+
+```plaintext
+script
+└── upgrade
+ ├── mysql
+ | ├── 1.2.3.sql
+ | ├── 2.0.0.sql
+ | ├── 2.1.0.sql
+ | └── 2.1.2.sql
+ └── pgsql
+ ├── 2.1.0.sql
+ ├── 2.1.2.sql
+ └── 2.1.3.sql
+```
+
+### 执行升级脚本
+
+使用数据库管理工具（如 MySQL Workbench、pgAdmin、JetBrains dataGrip）连接到数据库，并依次执行升级脚本。
+
+#### 示例：从 2.0.0 升级到 2.1.2
+
+1. **升级到 2.1.0**：
+
+```bash
+# 命令行或用您的数据库管理工具执行 2.1.2.sql 脚本
+mysql -h 127.0.0.1 -P 3306 -u root --password=streampark streampark <
./script/upgrade/mysql/2.1.0.sql
+```
+
+2. **升级到 2.1.2**：
+
+```bash
+# 接着，执行 2.1.2.sql 脚本完成升级
+mysql -h 127.0.0.1 -P 3306 -u root --password=streampark streampark <
./script/upgrade/mysql/2.1.2.sql
+```
+
+### 验证升级
+
+升级完成后，登录到您的应用程序并检查是否一切正常运行。您可以查看应用日志或检查新版本的功能是否按预期工作。
+
+### 遇到问题怎么办
+
+如果在升级过程中遇到任何问题：
+
+1. **参考官方文档**：查找可能的错误消息和解决方案。
+2. **恢复备份**：如果升级失败，使用之前备份的数据库恢复到升级前的状态。
+3. **寻求帮助**：如果问题仍然无法解决，您可以在 Apache StreamPark 的官方论坛或社区求助。
+
+### 下一步
+
+升级完成后，您可能需要根据新版本的特性和改进，调整和优化您的应用配置和性能设置。
