You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@shardingsphere.apache.org by du...@apache.org on 2022/08/25 11:52:11 UTC
[shardingsphere] branch master updated: Update release guide (#20522)
This is an automated email from the ASF dual-hosted git repository.
duanzhengqiang pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/shardingsphere.git
The following commit(s) were added to refs/heads/master by this push:
new 217d1d9429c Update release guide (#20522)
217d1d9429c is described below
commit 217d1d9429cdbaa1d72d899909c5c3fcd8e467af
Author: Liang Zhang <zh...@apache.org>
AuthorDate: Thu Aug 25 19:52:01 2022 +0800
Update release guide (#20522)
---
.../content/contribute/release/_index.cn.md | 7 +++
.../content/contribute/release/_index.en.md | 7 +++
.../elasticjob-ui.cn.md} | 6 +--
.../elasticjob-ui.en.md} | 6 +--
.../elasticjob.cn.md} | 6 +--
.../elasticjob.en.md} | 6 +--
.../shardingsphere.cn.md} | 61 ++++++++++++----------
.../shardingsphere.en.md} | 53 ++++++++++---------
docs/document/content/overview/intro.en.md | 5 +-
9 files changed, 89 insertions(+), 68 deletions(-)
diff --git a/docs/community/content/contribute/release/_index.cn.md b/docs/community/content/contribute/release/_index.cn.md
new file mode 100644
index 00000000000..2e64154a871
--- /dev/null
+++ b/docs/community/content/contribute/release/_index.cn.md
@@ -0,0 +1,7 @@
++++
+title = "发布指南"
+weight = 9
+chapter = true
++++
+
+请阅读本章节了解 Apache ShardingSphere 的新版本发布流程指南。
diff --git a/docs/community/content/contribute/release/_index.en.md b/docs/community/content/contribute/release/_index.en.md
new file mode 100644
index 00000000000..a6abe00ca2d
--- /dev/null
+++ b/docs/community/content/contribute/release/_index.en.md
@@ -0,0 +1,7 @@
++++
+title = "Release Guide"
+weight = 9
+chapter = true
++++
+
+Please read this chapter to know how to release new version of Apache ShardingSphere.
diff --git a/docs/community/content/contribute/release-elasticjob-ui.cn.md b/docs/community/content/contribute/release/elasticjob-ui.cn.md
similarity index 99%
rename from docs/community/content/contribute/release-elasticjob-ui.cn.md
rename to docs/community/content/contribute/release/elasticjob-ui.cn.md
index a4df66ba039..fa2141b4875 100644
--- a/docs/community/content/contribute/release-elasticjob-ui.cn.md
+++ b/docs/community/content/contribute/release/elasticjob-ui.cn.md
@@ -1,12 +1,12 @@
+++
title = "ElasticJob-UI 发布指南"
-weight = 10
+weight = 3
chapter = true
+++
## GPG 设置
-详情请参见[发布指南](/cn/contribute/release/)。
+详情请参见[发布指南](/cn/contribute/release/shardingsphere/)。
## 发布 Apache Maven 中央仓库
@@ -279,7 +279,7 @@ Keys to verify the Release Candidate:
https://dist.apache.org/repos/dist/dev/shardingsphere/KEYS
Look at here for how to verify this release candidate:
-https://shardingsphere.apache.org/community/en/contribute/release-elasticjob-ui/
+https://shardingsphere.apache.org/community/en/contribute/release/elasticjob-ui/
GPG user ID:
${YOUR.GPG.USER.ID}
diff --git a/docs/community/content/contribute/release-elasticjob-ui.en.md b/docs/community/content/contribute/release/elasticjob-ui.en.md
similarity index 99%
rename from docs/community/content/contribute/release-elasticjob-ui.en.md
rename to docs/community/content/contribute/release/elasticjob-ui.en.md
index 82356817d7b..d6ccd847704 100644
--- a/docs/community/content/contribute/release-elasticjob-ui.en.md
+++ b/docs/community/content/contribute/release/elasticjob-ui.en.md
@@ -1,12 +1,12 @@
+++
title = "ElasticJob-UI Release Guide"
-weight = 10
+weight = 3
chapter = true
+++
## GPG Settings
-Please refer to [Release Guide](/en/contribute/release/).
+Please refer to [Release Guide](/en/contribute/release/shardingsphere/).
## Apache Maven Central Repository Release
@@ -285,7 +285,7 @@ Keys to verify the Release Candidate:
https://dist.apache.org/repos/dist/dev/shardingsphere/KEYS
Look at here for how to verify this release candidate:
-https://shardingsphere.apache.org/community/en/contribute/release-elasticjob-ui/
+https://shardingsphere.apache.org/community/en/contribute/release/elasticjob-ui/
GPG user ID:
${YOUR.GPG.USER.ID}
diff --git a/docs/community/content/contribute/release-elasticjob.cn.md b/docs/community/content/contribute/release/elasticjob.cn.md
similarity index 99%
rename from docs/community/content/contribute/release-elasticjob.cn.md
rename to docs/community/content/contribute/release/elasticjob.cn.md
index 291c76337a8..c61489a43f4 100644
--- a/docs/community/content/contribute/release-elasticjob.cn.md
+++ b/docs/community/content/contribute/release/elasticjob.cn.md
@@ -1,6 +1,6 @@
+++
title = "ElasticJob 发布指南"
-weight = 9
+weight = 2
chapter = true
+++
@@ -8,7 +8,7 @@ chapter = true
### GPG 设置
-详情请参见[发布指南](/cn/contribute/release/)。
+详情请参见[发布指南](/cn/contribute/release/shardingsphere/)。
### 设置 settings.xml 文件
@@ -302,7 +302,7 @@ Keys to verify the Release Candidate:
https://dist.apache.org/repos/dist/dev/shardingsphere/KEYS
Look at here for how to verify this release candidate:
-https://shardingsphere.apache.org/community/en/contribute/release-elasticjob/
+https://shardingsphere.apache.org/community/en/contribute/release/elasticjob/
GPG user ID:
${YOUR.GPG.USER.ID}
diff --git a/docs/community/content/contribute/release-elasticjob.en.md b/docs/community/content/contribute/release/elasticjob.en.md
similarity index 99%
rename from docs/community/content/contribute/release-elasticjob.en.md
rename to docs/community/content/contribute/release/elasticjob.en.md
index 3dd568612e8..3c0acda439a 100644
--- a/docs/community/content/contribute/release-elasticjob.en.md
+++ b/docs/community/content/contribute/release/elasticjob.en.md
@@ -1,6 +1,6 @@
+++
title = "ElasticJob Release Guide"
-weight = 9
+weight = 2
chapter = true
+++
@@ -8,7 +8,7 @@ chapter = true
### GPG Setup
-Please refer to [Release Guide](/en/contribute/release/).
+Please refer to [Release Guide](/en/contribute/release/shardingsphere/).
### Setting settings.xml
@@ -304,7 +304,7 @@ Keys to verify the Release Candidate:
https://dist.apache.org/repos/dist/dev/shardingsphere/KEYS
Look at here for how to verify this release candidate:
-https://shardingsphere.apache.org/community/en/contribute/release-elasticjob/
+https://shardingsphere.apache.org/community/en/contribute/release/elasticjob/
GPG user ID:
${YOUR.GPG.USER.ID}
diff --git a/docs/community/content/contribute/release.cn.md b/docs/community/content/contribute/release/shardingsphere.cn.md
similarity index 91%
rename from docs/community/content/contribute/release.cn.md
rename to docs/community/content/contribute/release/shardingsphere.cn.md
index 08a49ef0127..318e34f3cc6 100644
--- a/docs/community/content/contribute/release.cn.md
+++ b/docs/community/content/contribute/release/shardingsphere.cn.md
@@ -1,49 +1,48 @@
+++
title = "ShardingSphere 发布指南"
-weight = 8
+weight = 1
chapter = true
+++
-## 发布前准备工作
+## 准备工作
### 1. 确认 Release Note
-Release Note 需提供中文/英文两种版本，确认中文描述是否明确，英文翻译是否准确，并按以下标签进行分类：
+Release Note 需提供中文/英文两种版本，确认中英文描述是否明确，并按以下标签进行分类：
-1. 新功能。
-2. API 变更。
-3. 功能增强。
-4. 重构。
-5. 漏洞修复。
+1. 新功能
+1. API 变更
+1. 功能增强
+1. 漏洞修复
### 2. 确认 Issue 列表
-打开 [Github Issues](https://github.com/apache/shardingsphere/issues) ，过滤 Milestone 为 `${RELEASE.VERSION}` 且状态为打开的 Issue:
+打开 [Github Issues](https://github.com/apache/shardingsphere/issues)，过滤 Milestone 为 `${RELEASE.VERSION}` 且状态为打开的 Issue:
1. 关闭已完成的 Issue；
-2. 未完成的 Issue 与负责人进行沟通，如果不影响本次发版，修改 Milestone 为下一个版本；
-3. 确认发布版本的 Milestone 下没有打开状态的 Issue。
+1. 未完成的 Issue 与负责人进行沟通，如果不影响本次发版，修改 Milestone 为下一个版本；
+1. 确认发布版本的 Milestone 下没有打开状态的 Issue。
-### 3. 确认 Pull request 列表
+### 3. 确认 Pull Request 列表
-打开 [Github Pull requests](https://github.com/apache/shardingsphere/pulls) ，过滤 Milestone 为 `${RELEASE.VERSION}` 且状态为打开的 Pull request:
+打开 [Github Pull requests](https://github.com/apache/shardingsphere/pulls)，过滤 Milestone 为 `${RELEASE.VERSION}` 且状态为打开的 Pull Request:
-1. 对打开的 Pull request 进行 Review 并且 Merge；
-2. 无法 Merge 且不影响本次发版的 Pull request，修改 Milestone 为下一个版本；
-3. 确认发布版本的 Milestone 下没有打开状态的 Pull request。
+1. 对打开的 Pull Request 进行 Review 并且 Merge；
+1. 无法 Merge 且不影响本次发版的 Pull Request，修改 Milestone 为下一个版本；
+1. 确认发布版本的 Milestone 下没有打开状态的 Pull Request。
-### 4. 关闭 Milestone
+### 4. 发送讨论邮件
-打开 [Github Milestone](https://github.com/apache/shardingsphere/milestones)
+1. 创建 [GitHub Discussion](https://github.com/apache/shardingsphere/discussions) 并在讨论内容中列出 Release Note；
+1. 发送邮件至 [dev@shardingsphere.apache.org](mailto:dev@shardingsphere.apache.org)，在邮件正文中链接 GitHub Discussion；
+1. 关注邮件列表，确认社区开发者对 Release Note 没有任何疑问。
-1. 确认 `${RELEASE.VERSION}` 的 Milestone 完成状态为 100%；
-2. 点击 `Close` 关闭 Milestone。
+### 5. 关闭 Milestone
-### 5. 发送讨论邮件
+打开 [Github Milestone](https://github.com/apache/shardingsphere/milestones)
-1. 创建 [GitHub Discussion](https://github.com/apache/shardingsphere/discussions) 并在讨论内容中列出 Release Note；
-2. 发送邮件至 [dev@shardingsphere.apache.org](mailto:dev@shardingsphere.apache.org)，在邮件正文中链接 GitHub Discussion；
-3. 关注邮件列表，确认社区开发者对 Release Note 没有任何疑问。
+1. 确认 `${RELEASE.VERSION}` 的 Milestone 完成状态为 100%；
+1. 点击 `Close` 关闭 Milestone。
## GPG 设置
@@ -453,7 +452,7 @@ Keys to verify the Release Candidate:
https://dist.apache.org/repos/dist/dev/shardingsphere/KEYS
Look at here for how to verify this release candidate:
-https://shardingsphere.apache.org/community/en/contribute/release/
+https://shardingsphere.apache.org/community/en/contribute/release/shardingsphere/
GPG user ID:
${YOUR.GPG.USER.ID}
@@ -624,10 +623,14 @@ Hi all,
Apache ShardingSphere Team is glad to announce the new release of Apache ShardingSphere ${RELEASE.VERSION}.
-Apache ShardingSphere is an open-source ecosystem consisted of a set of distributed database solutions, including 3 independent products, JDBC, Proxy & Sidecar (Planning).
-They all provide functions of data scale out, distributed transaction and distributed governance, applicable in a variety of situations such as Java isomorphism, heterogeneous language and cloud native.
-Apache ShardingSphere aiming at reasonably making full use of the computation and storage capacity of existed database in distributed system, rather than a totally new database.
-As the cornerstone of enterprises, relational database still takes a huge market share. Therefore, we prefer to focus on its increment instead of a total overturn.
+Apache ShardingSphere is an open source ecosystem that allows you to transform any database into a distributed database system.
+The project includes a JDBC and a Proxy, and its core adopts a micro-kernel and pluggable architecture.
+Thanks to its plugin-oriented architecture, features can be flexibly expanded at will.
+
+The project is committed to providing a multi-source heterogeneous, enhanced database platform and further building an ecosystem around the upper layer of the platform.
+Database Plus, the design philosophy of Apache ShardingSphere, aims at building the standard and ecosystem on the upper layer of the heterogeneous database.
+It focuses on how to make full and reasonable use of the computing and storage capabilities of existing databases rather than creating a brand new database.
+It attaches greater importance to the collaboration between multiple databases instead of the database itself.
Download Links: https://shardingsphere.apache.org/document/current/en/downloads/
diff --git a/docs/community/content/contribute/release.en.md b/docs/community/content/contribute/release/shardingsphere.en.md
similarity index 92%
rename from docs/community/content/contribute/release.en.md
rename to docs/community/content/contribute/release/shardingsphere.en.md
index 5dd9cc968f0..96d0413f01c 100644
--- a/docs/community/content/contribute/release.en.md
+++ b/docs/community/content/contribute/release/shardingsphere.en.md
@@ -4,47 +4,46 @@ weight = 8
chapter = true
+++
-## Prepare before release procedure
+## Prepare before release
### 1. Confirm release notes
-The release note should be provided in Chinese / English, confirm whether the Chinese description is clear and whether the English translation is accurate,
+The release note should be provided in English / Chinese, confirm whether English and Chinese description are clear,
and shall be classified according to the following labels:
1. New Feature
-2. API Change
-3. Enhancement
-4. Refactor
-5. Bug Fix
+1. API Change
+1. Enhancement
+1. Bug Fix
### 2. Confirm issue list
Open [GitHub issues](https://github.com/apache/shardingsphere/issues), filter the issue whose milestone is `${RELEASE.VERSION}` and status is open:
-1. Close the completed issue
-2. For outstanding issues, communicate with the developer in charge. If this release is not affected, modify milestone to the next version
-3. Confirm that there is no issue in open status under milestone of release version
+1. Close the completed issue;
+1. For outstanding issues, communicate with the developer in charge. If this release is not affected, modify milestone to the next version;
+1. Confirm that there is no issue in open status under milestone of release version.
### 3. Confirm pull request list
Open [GitHub pull requests](https://github.com/apache/shardingsphere/pulls), filter pull requests whose milestone is `${RELEASE.VERSION}` and status is open:
-1. Review the open pull request and merge
-2. For pull requests that cannot merge and do not affect this release, modify milestone to the next version
-3. Confirm that there is no open pull request under milestone of release version
+1. Review the open pull request and merge;
+1. For pull requests that cannot merge and do not affect this release, modify milestone to the next version;
+1. Confirm that there is no open pull request under milestone of release version.
-### 4. Close milestone
+### 4. Call for a discussion
-Open [GitHub milestone](https://github.com/apache/shardingsphere/milestones)
+1. Create a [GitHub Discussion](https://github.com/apache/shardingsphere/discussions) contains all the release notes;
+1. Send email to [dev@shardingsphere.apache.org](mailto:dev@shardingsphere.apache.org) with the GitHub Discussion in the message body;
+1. Follow the mailing list and confirm that the community developers have no questions about the release note.
-1. Confirm that the milestone completion status of `${RELEASE.VERSION}` is 100%
-2. Click `close` to close milestone
+### 5. Close milestone
-### 5. Call for a discussion
+Open [GitHub milestone](https://github.com/apache/shardingsphere/milestones)
-1. Create a [GitHub Discussion](https://github.com/apache/shardingsphere/discussions) contains all the release notes
-2. Send email to [dev@shardingsphere.apache.org](mailto:dev@shardingsphere.apache.org) with the GitHub Discussion in the message body
-3. Follow the mailing list and confirm that the community developers have no questions about the release note
+1. Confirm that the milestone completion status of `${RELEASE.VERSION}` is 100%;
+1. Click `close` to close milestone.
## GPG Settings
@@ -459,7 +458,7 @@ Keys to verify the Release Candidate:
https://dist.apache.org/repos/dist/dev/shardingsphere/KEYS
Look at here for how to verify this release candidate:
-https://shardingsphere.apache.org/community/en/contribute/release/
+https://shardingsphere.apache.org/community/en/contribute/release/shardingsphere/
GPG user ID:
${YOUR.GPG.USER.ID}
@@ -634,10 +633,14 @@ Hi all,
Apache ShardingSphere Team is glad to announce the new release of Apache ShardingSphere ${RELEASE.VERSION}.
-Apache ShardingSphere is an open-source ecosystem consisted of a set of distributed database solutions, including 3 independent products, JDBC, Proxy & Sidecar (Planning).
-They all provide functions of data scale out, distributed transaction and distributed governance, applicable in a variety of situations such as Java isomorphism, heterogeneous language and cloud native.
-Apache ShardingSphere aiming at reasonably making full use of the computation and storage capacity of existed database in distributed system, rather than a totally new database.
-As the cornerstone of enterprises, relational database still takes a huge market share. Therefore, we prefer to focus on its increment instead of a total overturn.
+Apache ShardingSphere is an open source ecosystem that allows you to transform any database into a distributed database system.
+The project includes a JDBC and a Proxy, and its core adopts a micro-kernel and pluggable architecture.
+Thanks to its plugin-oriented architecture, features can be flexibly expanded at will.
+
+The project is committed to providing a multi-source heterogeneous, enhanced database platform and further building an ecosystem around the upper layer of the platform.
+Database Plus, the design philosophy of Apache ShardingSphere, aims at building the standard and ecosystem on the upper layer of the heterogeneous database.
+It focuses on how to make full and reasonable use of the computing and storage capabilities of existing databases rather than creating a brand new database.
+It attaches greater importance to the collaboration between multiple databases instead of the database itself.
Download Links: https://shardingsphere.apache.org/document/current/en/downloads/
diff --git a/docs/document/content/overview/intro.en.md b/docs/document/content/overview/intro.en.md
index 40f85d84e61..724c1818adc 100644
--- a/docs/document/content/overview/intro.en.md
+++ b/docs/document/content/overview/intro.en.md
@@ -9,11 +9,12 @@ chapter = true
Apache ShardingSphere is an open source ecosystem that allows you to transform any database into a distributed database system.
The project includes a JDBC and a Proxy, and its core adopts a micro-kernel and pluggable architecture.
-Thanks to its plugin-oriented architecture, features can be flexibly expanded at will.
+Thanks to its plugin-oriented architecture, features can be flexibly expanded at will.
The project is committed to providing a multi-source heterogeneous, enhanced database platform and further building an ecosystem around the upper layer of the platform.
Database Plus, the design philosophy of Apache ShardingSphere, aims at building the standard and ecosystem on the upper layer of the heterogeneous database.
-It focuses on how to make full and reasonable use of the computing and storage capabilities of existing databases rather than creating a brand new database. It attaches greater importance to the collaboration between multiple databases instead of the database itself.
+It focuses on how to make full and reasonable use of the computing and storage capabilities of existing databases rather than creating a brand new database.
+It attaches greater importance to the collaboration between multiple databases instead of the database itself.
### ShardingSphere-JDBC