[release] Change release docs

apache · Apr 18, 2022 · 7afb4af · 7afb4af
1 parent 0e2eb70
commit 7afb4af
Show file tree

Hide file tree

Showing 6 changed files with 69 additions and 63 deletions.
diff --git a/community/en-us/release-post.md b/community/en-us/release-post.md
@@ -4,23 +4,7 @@
 
 For example, after the release of `x.y.z`, the following updates are required:
 
- - `docs/en-us/x.y.z` and `docs/zh-cn/x.y.z`: copy the old directory to the new version x.y.z
-   - The reference links of the included documents keep same with x.y.z, especially pay attention to the following file updates:
-     - `architecture-design.md`
-     - `cluster-deployment.md`
-     - `docker-deployment.md`
-     - `expansion-reduction.md`
-     - `kubernetes-deployment.md`
-     - `standalone-deployment.md`
-     - `upgrade.md`
- - `docs/en-us/release/history-versions.md` and `docs/zh-cn/release/history-versions.md`: Add the new version and link for x.y.z
- - `download/en-us/download.md` and `download/zh-cn/download.md`: add the download of the x.y.z release package
- - `site_config/docsx-y-z.js`: copy the old configuration file to the new version, and keep the content link same with x.y.z
- - `site_config/site.js`:
-   - `docsLatest`: update to x.y.z
-   - `docs0`: The `text` of two places of `en-us/zh-cn` needs to be updated to `latest(x.y.z)`
-   - `docsxyz`: Add a drop-down menu with `key` as `docsxyz` and `text` as `x.y.z` in `children` of two places of `en-us/zh-cn`
- - `src/pages/docs/index.md.jsx`: Add `'x.y.z': docsxyzConfig,`
+- `download/en-us/download.md` and `download/zh-cn/download.md`: add the download of the x.y.z release package
 
 ## Add New Version To GitHub's bug-report.yml
 

diff --git a/community/en-us/release-prepare.md b/community/en-us/release-prepare.md
@@ -12,16 +12,31 @@ Compared with the last release, the `release-docs` of the current release needs
 
 For example, to release `x.y.z`, the following updates are required:
 
- - `pom.xml`: `revision`, `version`, `tag` need to be updated to x.y.z
- - `sql`:
-   - `dolphinscheduler_mysql.sql`: `t_ds_version` needs to be updated to x.y.z
-   - `dolphinscheduler_postgre.sql`: `t_ds_version` needs to be updated to x.y.z
-   - `upgrade`: whether to add`x.y.z_schema`
-   - `soft_version`: need to be updated to x.y.z
- - `docker/docker-swarm`:
-   - `docker-compose.yml`: `image: dolphinscheduler.docker.scarf.sh/apache/dolphinscheduler` needs to be updated to x.y.z
-   - `docker-stack.yml`: `image: dolphinscheduler.docker.scarf.sh/apache/dolphinscheduler` needs to be updated to x.y.z
- - `docker/kubernetes/dolphinscheduler`:
-   - `Chart.yaml`: `appVersion` needs to be updated to x.y.z (`version` is helm chart version，incremented and different from x.y.z)
-   - `values.yaml`: `image.tag` needs to be updated to x.y.z
+- Version in the code:
+  - `sql`:
+    - `dolphinscheduler_mysql.sql`: `t_ds_version` needs to be updated to x.y.z
+    - `dolphinscheduler_postgre.sql`: `t_ds_version` needs to be updated to x.y.z
+    - `upgrade`: whether to add`x.y.z_schema`
+    - `soft_version`: need to be updated to x.y.z
+  - `docker/docker-swarm`:
+    - `docker-compose.yml`: `image: dolphinscheduler.docker.scarf.sh/apache/dolphinscheduler` needs to be updated to x.y.z
+    - `docker-stack.yml`: `image: dolphinscheduler.docker.scarf.sh/apache/dolphinscheduler` needs to be updated to x.y.z
+  - `docker/kubernetes/dolphinscheduler`:
+    - `Chart.yaml`: `appVersion` needs to be updated to x.y.z (`version` is helm chart version，incremented and different from x.y.z)
+    - `values.yaml`: `image.tag` needs to be updated to x.y.z
   - `dolphinscheduler-python/pydolphinscheduler/setup.py`: change `version` to x.y.z
+- Version in the docs:
+  - Change the placeholder `<version>` to the `x.y.z`
+    - `docker.md`
+    - `expansion-reduction.md`
+    - `kubernetes.md`
+    - `upgrade.md`
+  - Change configuration file
+    - `docs/configs/site.js`:
+      - `docsLatest`: update to x.y.z
+      - `docs0`: The `text` of two places of `en-us/zh-cn` needs to be updated to `latest(x.y.z)`
+      - `docsxyz`: Add a drop-down menu with `key` as `docsxyz` and `text` as `x.y.z` in `children` of two places of `en-us/zh-cn`
+    - `docs/configs/index.md.jsx`: Add `'x.y.z': docsxyzConfig`
+    - `docs/configs/docsdev.js`: Rename to `docsx-y-z.js` and change its content `/dev/` to `/x.y.z/`
+  - Add new history version
+    - `docs/docs/en/history-versions.md` and `docs/docs/zh/history-versions.md`: Add the new version and link for `x.y.z`
diff --git a/community/en-us/release.md b/community/en-us/release.md
@@ -243,8 +243,10 @@ cp -f ~/dolphinscheduler/dolphinscheduler-dist/target/python/* ~/ds_svn/dev/dolp
 ```shell
 shasum -a 512 apache-dolphinscheduler-${RELEASE.VERSION}-src.tar.gz >> apache-dolphinscheduler-${RELEASE.VERSION}-src.tar.gz.sha512
 shasum -b -a 512 apache-dolphinscheduler-${RELEASE.VERSION}-bin.tar.gz >> apache-dolphinscheduler-${RELEASE.VERSION}-bin.tar.gz.sha512
-shasum -a 512 python/apache-dolphinscheduler-${RELEASE.VERSION}.tar.gz >> python/apache-dolphinscheduler-${RELEASE.VERSION}.tar.gz.sha512
-shasum -b -a 512 python/apache_dolphinscheduler-${RELEASE.VERSION}-py3-none-any.whl >> python/apache_dolphinscheduler-${RELEASE.VERSION}-py3-none-any.whl.sha512
+cd python
+shasum -a 512 apache-dolphinscheduler-${RELEASE.VERSION}.tar.gz >> apache-dolphinscheduler-${RELEASE.VERSION}.tar.gz.sha512
+shasum -b -a 512 apache_dolphinscheduler-${RELEASE.VERSION}-py3-none-any.whl >> apache_dolphinscheduler-${RELEASE.VERSION}-py3-none-any.whl.sha512
+cd ../
 ```
 
 ### Commit to Apache SVN
@@ -260,8 +262,10 @@ svn --username=${APACHE LDAP username} commit -m "release ${RELEASE.VERSION}"
 ```shell
 shasum -c apache-dolphinscheduler-${RELEASE.VERSION}-src.tar.gz.sha512
 shasum -c apache-dolphinscheduler-${RELEASE.VERSION}-bin.tar.gz.sha512
+cd python
 shasum -c python/apache-dolphinscheduler-${RELEASE.VERSION}.tar.gz.sha512
 shasum -c python/apache_dolphinscheduler-${RELEASE.VERSION}-py3-none-any.whl.sha512
+cd ../
 ```
 
 ### Check gpg Signature

diff --git a/community/zh-cn/release-post.md b/community/zh-cn/release-post.md
@@ -4,23 +4,7 @@
 
 例如已发版 `x.y.z`，需要进行以下更新:
 
- - `docs/en-us/x.y.z` 和 `docs/zh-cn/x.y.z`: 复制老版本目录改为新版本 x.y.z
-   - 所包含文档的引用链接保持和 x.y.z 一致，尤其注意以下文件更新:
-     - `architecture-design.md`
-     - `cluster-deployment.md`
-     - `docker-deployment.md`
-     - `expansion-reduction.md`
-     - `kubernetes-deployment.md`
-     - `standalone-deployment.md`
-     - `upgrade.md`
- - `docs/en-us/release/history-versions.md` 和 `docs/zh-cn/release/history-versions.md`: 增加 x.y.z 的新 version 和 link
- - `download/en-us/download.md` 和 `download/zh-cn/download.md`: 增加 x.y.z 版本发布包的下载
- - `site_config/docsx-y-z.js`: 复制老配置文件改为新版本，内容链接保持和 x.y.z 一致
- - `site_config/site.js`:
-   - `docsLatest`: 更新为 x.y.z
-   - `docs0`: 两处 `en-us/zh-cn` 的 `text` 更新为 `latest(x.y.z)`
-   - `docsxyz`: 两处 `en-us/zh-cn` 的 `children` 增加 `key` 为 `docsxyz`, `text` 为 `x.y.z` 的下拉菜单
- - `src/pages/docs/index.md.jsx`: 增加 `'x.y.z': docsxyzConfig,`
+- `download/en-us/download.md` 和 `download/zh-cn/download.md`: 增加 x.y.z 版本发布包的下载
 
 ## 更新 GitHub issue 模板
 

diff --git a/community/zh-cn/release-prepare.md b/community/zh-cn/release-prepare.md
@@ -12,16 +12,31 @@
 
 例如要发版 `x.y.z`，需要先进行以下修改:
 
- - `pom.xml`: `revision`, `version`, `tag` 标签版本更新为 x.y.z
- - `sql`:
-   - `dolphinscheduler_mysql.sql`: `t_ds_version` 版本更新为 x.y.z
-   - `dolphinscheduler_postgre.sql`: `t_ds_version` 版本更新为 x.y.z
-   - `upgrade`: 是否新增 `x.y.z_schema`
-   - `soft_version`: 版本更新为 x.y.z
- - `docker/docker-swarm`:
-   - `docker-compose.yml`: `image: dolphinscheduler.docker.scarf.sh/apache/dolphinscheduler` 版本更新为 x.y.z
-   - `docker-stack.yml`: `image: dolphinscheduler.docker.scarf.sh/apache/dolphinscheduler` 版本更新为 x.y.z
- - `docker/kubernetes/dolphinscheduler`:
-   - `Chart.yaml`: `appVersion` 版本更新为 x.y.z (`version` 为 helm chart 版本, 增量更新但不要设置为 x.y.z)
-   - `values.yaml`: `image.tag` 版本更新为 x.y.z
- - `dolphinscheduler-python/pydolphinscheduler/setup.py`: 修改其中的 `version` 为 x.y.z
+- 修改代码中的版本号:
+  - `sql`:
+    - `dolphinscheduler_mysql.sql`: `t_ds_version` 版本更新为 x.y.z
+    - `dolphinscheduler_postgre.sql`: `t_ds_version` 版本更新为 x.y.z
+    - `upgrade`: 是否新增 `x.y.z_schema`
+    - `soft_version`: 版本更新为 x.y.z
+  - `docker/docker-swarm`:
+    - `docker-compose.yml`: `image: dolphinscheduler.docker.scarf.sh/apache/dolphinscheduler` 版本更新为 x.y.z
+    - `docker-stack.yml`: `image: dolphinscheduler.docker.scarf.sh/apache/dolphinscheduler` 版本更新为 x.y.z
+  - `docker/kubernetes/dolphinscheduler`:
+    - `Chart.yaml`: `appVersion` 版本更新为 x.y.z (`version` 为 helm chart 版本, 增量更新但不要设置为 x.y.z)
+    - `values.yaml`: `image.tag` 版本更新为 x.y.z
+  - `dolphinscheduler-python/pydolphinscheduler/setup.py`: 修改其中的 `version` 为 x.y.z
+- 修改文档（docs模块）中的版本号:
+  - 将下面文件的占位符 `<version>` 修改成 `x.y.z`
+    - `docker.md`
+    - `expansion-reduction.md`
+    - `kubernetes.md`
+    - `upgrade.md`
+  - 修改配置文件的版本号
+     - `docs/configs/site.js`:
+       - `docsLatest`: 更新为 x.y.z
+       - `docs0`: 两处 `en-us/zh-cn` 的 `text` 更新为 `latest(x.y.z)`
+       - `docsxyz`: 两处 `en-us/zh-cn` 的 `children` 增加 `key` 为 `docsxyz`, `text` 为 `x.y.z` 的下拉菜单
+     - `docs/configs/index.md.jsx`: 增加 `'x.y.z': docsxyzConfig,`
+     - `docs/configs/docsdev.js`: 重命名为 `docsx-y-z.js` 并将其中的 `/dev/` 修改为 `/x.y.z/`
+  - 新增历史版本
+     - `docs/docs/en/history-versions.md` 和 `docs/docs/zh/history-versions.md`: 增加新的历史版本为 `x.y.z`
diff --git a/community/zh-cn/release.md b/community/zh-cn/release.md
@@ -263,8 +263,10 @@ cp -f ~/dolphinscheduler/dolphinscheduler-dist/target/python/* ~/ds_svn/dev/dolp
 ```shell
 shasum -a 512 apache-dolphinscheduler-${RELEASE.VERSION}-src.tar.gz >> apache-dolphinscheduler-${RELEASE.VERSION}-src.tar.gz.sha512
 shasum -b -a 512 apache-dolphinscheduler-${RELEASE.VERSION}-bin.tar.gz >> apache-dolphinscheduler-${RELEASE.VERSION}-bin.tar.gz.sha512
-shasum -a 512 python/apache-dolphinscheduler-${RELEASE.VERSION}.tar.gz >> python/apache-dolphinscheduler-${RELEASE.VERSION}.tar.gz.sha512
-shasum -b -a 512 python/apache_dolphinscheduler-${RELEASE.VERSION}-py3-none-any.whl >> python/apache_dolphinscheduler-${RELEASE.VERSION}-py3-none-any.whl.sha512
+cd python
+shasum -a 512 apache-dolphinscheduler-${RELEASE.VERSION}.tar.gz >> apache-dolphinscheduler-${RELEASE.VERSION}.tar.gz.sha512
+shasum -b -a 512 apache_dolphinscheduler-${RELEASE.VERSION}-py3-none-any.whl >> apache_dolphinscheduler-${RELEASE.VERSION}-py3-none-any.whl.sha512
+cd  ../
 ```
 
 ### 提交Apache SVN
@@ -281,8 +283,10 @@ svn --username=${APACHE LDAP 用户名} commit -m "release ${RELEASE.VERSION}"
 ```shell
 shasum -c apache-dolphinscheduler-${RELEASE.VERSION}-src.tar.gz.sha512
 shasum -c apache-dolphinscheduler-${RELEASE.VERSION}-bin.tar.gz.sha512
+cd python
 shasum -c python/apache-dolphinscheduler-${RELEASE.VERSION}.tar.gz.sha512
 shasum -c python/apache_dolphinscheduler-${RELEASE.VERSION}-py3-none-any.whl.sha512
+cd ../
 ```
 
 ### 检查gpg签名