You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@dolphinscheduler.apache.org by zh...@apache.org on 2022/07/27 03:15:15 UTC
[dolphinscheduler] branch dev updated: [doc] Add new page incompatible change (#11153)
This is an automated email from the ASF dual-hosted git repository.
zhongjiajie pushed a commit to branch dev
in repository https://gitbox.apache.org/repos/asf/dolphinscheduler.git
The following commit(s) were added to refs/heads/dev by this push:
new de5c22b276 [doc] Add new page incompatible change (#11153)
de5c22b276 is described below
commit de5c22b27654e3f3fd48ea3be97ce994be52a94d
Author: Jiajie Zhong <zh...@hotmail.com>
AuthorDate: Wed Jul 27 11:15:09 2022 +0800
[doc] Add new page incompatible change (#11153)
Add incompatibles and give some hint to user when then
want to upgrade to specific version.
ref: #10607
---
.github/PULL_REQUEST_TEMPLATE.md | 4 ++++
docs/configs/docsdev.js | 22 ++++++++++++++++++++--
docs/docs/en/guide/upgrede/incompatible.md | 9 +++++++++
docs/docs/en/guide/{ => upgrede}/upgrade.md | 10 +++++++---
docs/docs/zh/guide/upgreade/incompatible.md | 9 +++++++++
docs/docs/zh/guide/{ => upgreade}/upgrade.md | 10 +++++++---
6 files changed, 56 insertions(+), 8 deletions(-)
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
index 61603fadc6..5417822bc6 100644
--- a/.github/PULL_REQUEST_TEMPLATE.md
+++ b/.github/PULL_REQUEST_TEMPLATE.md
@@ -28,3 +28,7 @@ This change added tests and can be verified as follows:
- *Added dolphinscheduler-dao tests for end-to-end.*
- *Added CronUtilsTest to verify the change.*
- *Manually verified the change by testing locally.* -->
+
+(or)
+
+If your pull request contain incompatible change, you should also add it to `docs/docs/en/guide/upgrede/incompatible.md`
diff --git a/docs/configs/docsdev.js b/docs/configs/docsdev.js
index d74dba0a67..30a3c80b94 100644
--- a/docs/configs/docsdev.js
+++ b/docs/configs/docsdev.js
@@ -338,7 +338,16 @@ export default {
},
{
title: 'Upgrade',
- link: '/en-us/docs/dev/user_doc/guide/upgrade.html',
+ children: [
+ {
+ title: 'Incompatible',
+ link: '/en-us/docs/dev/user_doc/guide/upgrade/incompatible.html',
+ },
+ {
+ title: 'Upgrade',
+ link: '/en-us/docs/dev/user_doc/guide/upgrade/upgrade.html',
+ },
+ ],
},
{
title: 'Expansion and Reduction',
@@ -738,7 +747,16 @@ export default {
},
{
title: '升级',
- link: '/zh-cn/docs/dev/user_doc/guide/upgrade.html',
+ children: [
+ {
+ title: '不向前兼容的更新',
+ link: '/zh-cn/docs/dev/user_doc/guide/upgrade/incompatible.html',
+ },
+ {
+ title: '升级步骤',
+ link: '/zh-cn/docs/dev/user_doc/guide/upgrade/upgrade.html',
+ },
+ ],
},
{
title: '扩/缩容',
diff --git a/docs/docs/en/guide/upgrede/incompatible.md b/docs/docs/en/guide/upgrede/incompatible.md
new file mode 100644
index 0000000000..d1043983c9
--- /dev/null
+++ b/docs/docs/en/guide/upgrede/incompatible.md
@@ -0,0 +1,9 @@
+# Incompatible
+
+This document records the incompatible updates between each version. You need to check this document before you upgrade to related version.
+
+## dev
+
+## 3.0.0
+
+* Copy and import workflow without 'copy' suffix [#10607](https://github.com/apache/dolphinscheduler/pull/10607)
\ No newline at end of file
diff --git a/docs/docs/en/guide/upgrade.md b/docs/docs/en/guide/upgrede/upgrade.md
similarity index 88%
rename from docs/docs/en/guide/upgrade.md
rename to docs/docs/en/guide/upgrede/upgrade.md
index af44a7483c..f1a518e644 100644
--- a/docs/docs/en/guide/upgrade.md
+++ b/docs/docs/en/guide/upgrede/upgrade.md
@@ -2,6 +2,10 @@
## Prepare
+### Check Incompatible Change
+
+You should check [incompatible change](./incompatible.md) before you upgrade, because some incompatible change may break your current function.
+
### Backup Previous Version's Files and Database
To prevent data loss by some miss-operation, it is recommended to back up data before upgrading. The backup way according to your environment.
@@ -15,7 +19,7 @@ directory where current service running. And all below command is running in thi
### Stop All Services of DolphinScheduler
-Stop all services of dolphinscheduler according to your deployment method. If you deploy your dolphinscheduler according to [cluster deployment](./installation/cluster.md), you can stop all services by command `sh ./script/stop-all.sh`.
+Stop all services of dolphinscheduler according to your deployment method. If you deploy your dolphinscheduler according to [cluster deployment](../installation/cluster.md), you can stop all services by command `sh ./script/stop-all.sh`.
### Upgrade Database
@@ -38,8 +42,8 @@ Execute database upgrade script: `sh ./tools/bin/upgrade-schema.sh`
#### Change Configuration `bin/env/install_config.conf`
-- If you deploy with Pseudo-Cluster deployment, change it according to [Pseudo-Cluster](./installation/pseudo-cluster.md) section "Modify Configuration".
-- If you deploy with Cluster deployment, change it according to [Cluster](./installation/cluster.md) section "Modify Configuration".
+- If you deploy with Pseudo-Cluster deployment, change it according to [Pseudo-Cluster](../installation/pseudo-cluster.md) section "Modify Configuration".
+- If you deploy with Cluster deployment, change it according to [Cluster](../installation/cluster.md) section "Modify Configuration".
And them run command `sh ./bin/start-all.sh` to start all services.
diff --git a/docs/docs/zh/guide/upgreade/incompatible.md b/docs/docs/zh/guide/upgreade/incompatible.md
new file mode 100644
index 0000000000..285505b8fe
--- /dev/null
+++ b/docs/docs/zh/guide/upgreade/incompatible.md
@@ -0,0 +1,9 @@
+# 不向前兼容的更新
+
+本文档记录了各版本之间不兼容的更新内容。在升级到相关版本前，请检查本文档。
+
+## dev
+
+## 3.0.0
+
+* Copy and import workflow without 'copy' suffix [#10607](https://github.com/apache/dolphinscheduler/pull/10607)
\ No newline at end of file
diff --git a/docs/docs/zh/guide/upgrade.md b/docs/docs/zh/guide/upgreade/upgrade.md
similarity index 85%
rename from docs/docs/zh/guide/upgrade.md
rename to docs/docs/zh/guide/upgreade/upgrade.md
index a8483cce69..1a37cd0e76 100644
--- a/docs/docs/zh/guide/upgrade.md
+++ b/docs/docs/zh/guide/upgreade/upgrade.md
@@ -2,6 +2,10 @@
## 准备工作
+### 检查不向前兼容的更改
+
+在升级之前，您应该检查 [incompatible change](./incompatible.md)，因为一些不兼容的更改可能会破坏您当前的功能。
+
### 备份上一版本文件和数据库
为了防止操作错误导致数据丢失，建议升级之前备份数据，备份方法请结合你数据库的情况来定
@@ -14,7 +18,7 @@
### 停止 dolphinscheduler 所有服务
-根据你部署方式停止 dolphinscheduler 的所有服务，如果你是通过 [集群部署](./installation/cluster.md) 来部署你的 dolphinscheduler 的话，可以通过 `sh ./script/stop-all.sh` 停止全部服务。
+根据你部署方式停止 dolphinscheduler 的所有服务，如果你是通过 [集群部署](../installation/cluster.md) 来部署你的 dolphinscheduler 的话，可以通过 `sh ./script/stop-all.sh` 停止全部服务。
### 数据库升级
@@ -37,8 +41,8 @@ jar 包 并添加到 `./tools/libs` 目录下，修改 `./bin/env/dolphinschedul
#### 修改 `bin/env/install_config.conf` 配置内容
-- 伪集群部署请参照[伪集群部署(Pseudo-Cluster)](./installation/pseudo-cluster.md)中的 `修改相关配置`
-- 集群部署请参照[集群部署(Cluster)](./installation/cluster.md)中的 `修改相关配置`
+- 伪集群部署请参照[伪集群部署(Pseudo-Cluster)](../installation/pseudo-cluster.md)中的 `修改相关配置`
+- 集群部署请参照[集群部署(Cluster)](../installation/cluster.md)中的 `修改相关配置`
然后运行命令 `sh ./bin/start-all.sh` 重启全部服务。