diff --git a/docs/cn/MatrixOne/Contribution-Guide/Code-Style/code-comment-style.md b/docs/cn/MatrixOne/Contribution-Guide/Code-Style/code-comment-style.md
index 9c8cd4c8f6096af92d86990bedd19fea4cd40522..ce58f5c06275b873a4a15427d59066f0e828832a 100644
--- a/docs/cn/MatrixOne/Contribution-Guide/Code-Style/code-comment-style.md
+++ b/docs/cn/MatrixOne/Contribution-Guide/Code-Style/code-comment-style.md
@@ -25,7 +25,7 @@
- Package (Go)
- File
- Type
-- Constant
+- Constant
- Function
- Method
- Variable
@@ -58,18 +58,18 @@
- 请统一使用 **美式英语**
- color, canceling, synchronize (推荐)
- colour, cancelling, synchronise (不推荐)
-
+
- 注意拼写正确
- 使用**标准或官方的大写**
-
- - MatrixOne, MatrixCube, Raft, SQL (正确)
- - matrixone, matrixcube, RAFT, sql (错误)
+
+ - MatrixOne, Raft, SQL (正确)
+ - matrixone, RAFT, sql (错误)
- 使用一致性的短语和词汇
-
+
- "dead link" vs. "broken link" （在一篇文章或文件中只能出现其中一个）
-
+
- 不要使用冗长的复合词
- 尽量不使用缩写
@@ -82,11 +82,11 @@
- 尽量使用短句
- 句子首字母大写，并以句号结尾
-
+
- 如果一个小写的标识符位于句子开头，可以不用大写
```
- // enterGame causes Players to enter the
+ // enterGame causes Players to enter the
// video game, which is about a romantic
// story in ancient China.
func enterGame() os.Error {
@@ -99,13 +99,13 @@
- Opens the file (正确)
- Open the file (错误)
-- 使用 "this" 而非"the"来指代当前事物
-
+- 使用 "this" 而非"the"来指代当前事物
+
- Gets the toolkit for this component (推荐)
- Gets the toolkit for the component (不推荐)
- 允许使用Markdown语法格式
-
+
- Opens the `log` file
### Tips
@@ -117,4 +117,4 @@
- 确保及时更新注释
- 保证注释清楚易懂
-感谢您的贡献!
\ No newline at end of file
+感谢您的贡献!
diff --git a/docs/cn/MatrixOne/Contribution-Guide/How-to-Contribute/preparation.md b/docs/cn/MatrixOne/Contribution-Guide/How-to-Contribute/preparation.md
index f2ff28bcdf831846892e640494a61f03def1c8c9..7ff10acad1aa1282b024aaaee70a9fec79bf2b36 100644
--- a/docs/cn/MatrixOne/Contribution-Guide/How-to-Contribute/preparation.md
+++ b/docs/cn/MatrixOne/Contribution-Guide/How-to-Contribute/preparation.md
@@ -9,7 +9,7 @@
### 特点与框架
在[MatrixOne简介](./../../Overview/matrixone-introduction.md)中您可以了解到MO的超融合、云边协同特性以及其所创造的优异表现与独特价值。
-此外，在[MatrixOne框架](./../../Overview/matrixone-architecture.md)中您可以详细地了解MO的整体架构，以及存储层、计算层、负责分布式管理的MatrixCube的具体组成情况。
+此外，在[MatrixOne框架](./../../Overview/matrixone-architecture.md)中您可以详细地了解 MatrixOne 的整体架构，以及存储层、日志层等具体组成情况。
同时，你也可以查阅[MatrixOne术语表](../../Glossary/glossary.md)来了解一些复杂的词汇。
在技术层面，[SQL参考指南](./../../Reference/SQL-Reference/Data-Definition-Statements/create-database.md) 为您提供了详细的SQL语言的参考，其中对语法和示例都有详细解释；同样，[自定义函数](./../../Reference/Builtin-Functions/Datetime/year.md)提供了MO中自定义函数的相关解释。
@@ -39,7 +39,7 @@
| **optools** | 测试与部署工具 |
| **pkg** | MatrixOne项目的主要代码库 |
-对于不同的技术模块，`/pkg`喜爱的代码结构如下表所示。详情请参照[MatrixOne技术架构](../../Overview/MatrixOne-Tech-Design/matrixone-techdesign.md)。
+对于不同的技术模块，`/pkg`喜爱的代码结构如下表所示。
| 目录 | 模块 |
| ------------------------------ | ------------------------------------------------------------ |
@@ -48,7 +48,6 @@
| **sql/** | MPP SQL Execution |
| **sql/vectorize** | SQL的向量化执行 |
| **catalog/** | 存储元数据的Catalog |
-| **github.com/matrixorigin/matrixcube** | MatrixCube |
| **vm/engine** |存储引擎 |
| **vm/engine/aoe** | AOE引擎（分析优化引擎） |
| **vm/engine/tpe** | TPE引擎（事务处理引擎） |
diff --git a/docs/cn/MatrixOne/Overview/matrixone-architecture.md b/docs/cn/MatrixOne/Overview/matrixone-architecture.md
index d36f27661ea9ae60a1ba48f8699a7376171fdfc3..bf25898308e5c0c2ac4768b32bc7c0d35163e842 100644
--- a/docs/cn/MatrixOne/Overview/matrixone-architecture.md
+++ b/docs/cn/MatrixOne/Overview/matrixone-architecture.md
@@ -40,10 +40,7 @@ Serverless 层是一系列无状态节点的总称，整体上包含三类：
## **相关信息**
-本节介绍了MatrixOne的整体架构概览。若您想了解更详细的模块技术设计问题，可阅读：
-[MatrixOne模块概览](MatrixOne-Tech-Design/matrixone-techdesign.md)
-
-其他信息可参见：
+本节介绍了MatrixOne的整体架构概览。其他信息可参见：
* [安装MatrixOne](../Get-Started/install-standalone-matrixone.md)
* [MySQL兼容性](mysql-compatibility.md)
diff --git a/docs/cn/MatrixOne/glossary.md b/docs/cn/MatrixOne/glossary.md
index dc2bb870a4918ef6a51a1b2c4f353ea8eaf42868..ad754a8b76bbae9641d478ef924d31d9ae7f0199 100644
--- a/docs/cn/MatrixOne/glossary.md
+++ b/docs/cn/MatrixOne/glossary.md
@@ -11,7 +11,7 @@
| C | |
| Cluster | MatrixOne的分布式部署形式，由多台主机组成，在逻辑上构成一个整体。|
| D | |
- | Data Storage | DataStorage接口实现了分布式存储服务，必须在使用MatrixCube之前就预先定义。并且，DataStorage的实现依赖于存储引擎的具体特性 |
+ | Data Storage | DataStorage接口实现了分布式存储服务<!--，必须在使用MatrixCube之前就预先定义-->。并且，DataStorage的实现依赖于存储引擎的具体特性 |
| E | |
| Event Notify | 将心跳(Hearbeat)信息同步到所有节点的机制称为Event Notify。|
| Explicit Transactions| 显式事务，即是一种指定的事务，这种事务需要由你自己决定哪批工作必须成功完成，否则所有部分都不完成。可以使用 `BEGIN TRANSACTION` 和
@@ -23,17 +23,16 @@
|I| |
| Implicit transactions| 隐式事务，即自动提交事务。 |
| M | |
- | MatrixCube | MatrixCube是一个构建分布式系统的框架，保证了集群的可用性、一致性以及可扩展性。MatrixCube的设计目标是让开发人员只需要关注一个节点上的业务逻辑但却能够轻松实现各种强一致的分布式存储服务。|
| P | |
- | Prophet | Prophet是MatrixCube中的调度模块，执行Auto-Rebalance操作来维持集群中各个节点的存储量、读写负载均衡。集群中最初的三个节点将作为Prophet节点。|
+ | Prophet | Prophet是<!--MatrixCube中的-->调度模块，执行Auto-Rebalance操作来维持集群中各个节点的存储量、读写负载均衡。集群中最初的三个节点将作为Prophet节点。|
| Pure Storage | 与Prophet相对, pure storage是另一种类型的节点，并不执行调度工作，只进行普通的存储工作。|
| R | |
| Replica | 为了保证存储服务的高可用性，每部分数据需要存储多份，并且分布在不同的节点上，因此将一个数据副本称之为一个Replica。同一部分的数据会包含多个Replica，并且每个Replica中的数据都是相同的。 |
| S | |
| Snapshot Isolation (SI) | Snapshot Isolation是一种在实践中广泛应用的多版本并发控制技术，MatrixOne支持Snapshot隔离级别的分布式事务。|
- | Store |MatrixCube分布式系统包括一定数量的主机，数据正是存放在这些机器中，而我们把集群中的每台主机称之为Store。|
- | Shard | 数据库中的数据按逻辑组织成表，而数据又可以按照不同的分区进行存储，如此可以得到更好的扩展性。因此，数据在MatrixCube集群中分片存储，每个数据分片我们称之为一个Shard，而一个Store中可以管理多个Shard；当Shard的存储容量超过限制时，会进行分裂(Split)。 |
- | Shard Splitting | 当一个Shard超过了规定的存储容量限制时，MatrixCube将会把该Shard分裂（Split）为两个存储量相当的Shard。 |
+ | Store |<!--MatrixCube-->分布式系统包括一定数量的主机，数据正是存放在这些机器中，而我们把集群中的每台主机称之为Store。|
+ | Shard | 数据库中的数据按逻辑组织成表，而数据又可以按照不同的分区进行存储，如此可以得到更好的扩展性。因此，数据在<!--MatrixCube-->集群中分片存储，每个数据分片我们称之为一个Shard，而一个Store中可以管理多个Shard；当Shard的存储容量超过限制时，会进行分裂(Split)。 |
+ | Shard Splitting | 当一个Shard超过了规定的存储容量限制时，<!--MatrixCube-->集群将会把该Shard分裂（Split）为两个存储量相当的Shard。 |
| Shard Proxy | Shard Proxy是接受用户读写请求的中心模块，在收到请求后将其发送到相应的节点以做出回应|
### **重要概念**
diff --git a/docs/cn/README.md b/docs/cn/README.md
index f35ba21759da1b2c42983f26c9d8ecfa4c91f1e6..d035143bceddca0750a96945d6fd59c25fab7bc2 100644
--- a/docs/cn/README.md
+++ b/docs/cn/README.md
@@ -14,4 +14,4 @@ MatrixOne通过超融合数据引擎实现单一数据库系统支持事务性
| ---- | ---- | ----
| [MatrixOne简介](MatrixOne/Overview/matrixone-introduction.md) | [MatrixOne安装部署](MatrixOne/Get-Started/install-standalone-matrixone.md) | [SQL参考指南](MatrixOne/Reference/SQL-Reference/Data-Definition-Statements/create-database.md)
| [MatrixOne架构](MatrixOne/Overview/matrixone-architecture.md) | [连接MatrixOne服务](MatrixOne/Get-Started/connect-to-matrixone-server.md) | [v0.5.0发布公告](MatrixOne/Release-Notes/v0.5.0.md)
-| [MatrixCube简介](MatrixOne/Overview/matrixcube/matrixcube-introduction.md) | [使用MatrixOne完成SSB测试](MatrixOne/Get-Started/Tutorial/SSB-test-with-matrixone.md)
+| [MySQL兼容性](MatrixOne/Overview/mysql-compatibility.md) | [使用MatrixOne完成SSB测试](MatrixOne/Get-Started/Tutorial/SSB-test-with-matrixone.md)
diff --git a/docs/en/MatrixOne/Contribution-Guide/Code-Style/code-comment-style.md b/docs/en/MatrixOne/Contribution-Guide/Code-Style/code-comment-style.md
index 7fed04a43c31e5977be0f01ec7b3d0d84111f35f..df5dbec069c9d01d6d5e62df2fdf2ed7e19b6eec 100644
--- a/docs/en/MatrixOne/Contribution-Guide/Code-Style/code-comment-style.md
+++ b/docs/en/MatrixOne/Contribution-Guide/Code-Style/code-comment-style.md
@@ -26,7 +26,7 @@ A comment is generally required for:
- Package (Go)
- File
- Type
-- Constant
+- Constant
- Function
- Method
- Variable
@@ -41,7 +41,7 @@ A comment is generally required for:
### Format of a good comment
- Go
-
+
- Use `//` for a single-line comment and trailing comment
- Use `/* ... */` for a block comment (used only when needed)
- Use **gofmt** to format your code
@@ -57,23 +57,23 @@ A comment is generally required for:
### Language for a good comment
- Word
-
+
- Use **American English** rather than British English
-
+
- color, canceling, synchronize (Recommended)
- colour, cancelling, synchronise (Not recommended)
-
+
- Use correct spelling
- Use **standard or official capitalization**
-
- - MatrixOne, MatrixCube, Raft, SQL (Right)
- - matrixone, matrixcube, RAFT, sql (Wrong)
+
+ - MatrixOne, Raft, SQL (Right)
+ - matrixone, RAFT, sql (Wrong)
- Use words and expressions consistently
-
+
- "dead link" vs. "broken link" (Only one of them can appear in a single document)
-
+
- Do not use lengthy compound words
- Do not abbreviate unless it is absolutely necessary
@@ -86,11 +86,11 @@ A comment is generally required for:
- Use relatively short sentences
- Capitalize the first letter of sentences and end them with periods
-
+
- If a lower-case identifier comes at the beginning of a sentence, don't capitalize it
```
- // enterGame causes Players to enter the
+ // enterGame causes Players to enter the
// video game, which is about a romantic
// story in ancient China.
func enterGame() os.Error {
@@ -104,12 +104,12 @@ A comment is generally required for:
- Open the file (Wrong)
- Use "this" instead of "the" to refer to the current thing
-
+
- Gets the toolkit for this component (Recommended)
- Gets the toolkit for the component (Not recommended)
- The Markdown format is allowed
-
+
- Opens the `log` file
### Tips for a good comment
@@ -121,4 +121,4 @@ A comment is generally required for:
- Make sure the comment is up-to-date
- Let the code speak for itself
-Thanks for your contribution!
\ No newline at end of file
+Thanks for your contribution!
diff --git a/docs/en/MatrixOne/Contribution-Guide/Code-Style/code-of-conduct.md b/docs/en/MatrixOne/Contribution-Guide/Code-Style/code-of-conduct.md
index 0584510912e970b22071743fb76beadea454c179..a5806994a7435be2dd49b2e925b7dbd2d5a6150e 100644
--- a/docs/en/MatrixOne/Contribution-Guide/Code-Style/code-of-conduct.md
+++ b/docs/en/MatrixOne/Contribution-Guide/Code-Style/code-of-conduct.md
@@ -5,7 +5,7 @@
In the interest of fostering an open and welcoming environment, we as
contributors and maintainers pledge to make participation in our project and
our community a harassment-free experience for everyone, regardless of age, body
-size, disability, ethnicity, sex characteristics, gender identity and expression,
+size, disability, ethnicity, sex characteristics, gender identity, and expression,
level of experience, education, socio-economic status, nationality, personal
appearance, race, religion, or sexual identity and orientation.
@@ -45,7 +45,7 @@ threatening, offensive, or harmful.
## **Scope**
-This Code of Conduct applies within all project spaces, and it also applies when
+This Code of Conduct applies within all project spaces, and when
an individual is representing the project or its community in public spaces.
Examples of representing a project or community include using an official
project e-mail address, posting via an official social media account, or acting
@@ -56,14 +56,13 @@ a project may be further defined and clarified by project maintainers.
Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported by contacting the project team at hai.jin@matrixorigin.io. All
-complaints will be reviewed and investigated and will result in a response that
-is deemed necessary and appropriate to the circumstances. The project team is
+complaints will be reviewed and investigated and resulting in a response deemed necessary and appropriate to the circumstances. The project team is
obligated to maintain confidentiality with regard to the reporter of an incident.
Further details of specific enforcement policies may be posted separately.
Project maintainers who do not follow or enforce the Code of Conduct in good
faith may face temporary or permanent repercussions as determined by other
-members of the project's leadership.
+the project leadership members.
## **Attribution**
@@ -73,4 +72,4 @@ available at <https://www.contributor-covenant.org/version/1/4/code-of-conduct.h
[homepage]: https://www.contributor-covenant.org
For answers to common questions about this code of conduct, see
-<https://www.contributor-covenant.org/faq>
\ No newline at end of file
+<https://www.contributor-covenant.org/faq>
diff --git a/docs/en/MatrixOne/Contribution-Guide/Code-Style/commit-pr-style.md b/docs/en/MatrixOne/Contribution-Guide/Code-Style/commit-pr-style.md
index 980ab1ead555f92447aab000ce9d588544deeac0..e8fac5f330af0c2d9d0e0b189830dee1dec88ba1 100644
--- a/docs/en/MatrixOne/Contribution-Guide/Code-Style/commit-pr-style.md
+++ b/docs/en/MatrixOne/Contribution-Guide/Code-Style/commit-pr-style.md
@@ -1,6 +1,6 @@
# Commit Message and Pull Request Style
-This document describes the commit message and Pull Request style applied to all MatrixOrigin repositories. When you are ready to commit, be sure to follow the style guide to write a good commit message, a good Pull Request title, and description.
+This document describes the commit message and Pull Request style applied to all MatrixOrigin repositories. When you are ready to commit, be sure to follow the style guide to write a good commit message, a good Pull Request title, and a description.
## Why a good commit message matters
@@ -17,7 +17,7 @@ Elements of a good commit message:
1. **What is your change? (mandatory)**
- It can be fixing a specific bug, adding a feature, improving performance, reliability and stability, or just be a change for the sake of correctness.
+ It can be fixing a specific bug, adding a feature, improving performance, reliability, and stability, or just being a change for the sake of correctness.
2. **Why was this change made? (mandatory)**
@@ -29,7 +29,7 @@ Elements of a good commit message:
## How to write a good commit message
-To write a good commit message, we suggest following good format, cultivating good habits, and using good language.
+To write a good commitment message, we suggest following a good format, cultivating good habits, and using good language.
### Format of a good commit message
@@ -45,7 +45,7 @@ Please follow the following style for **all your commits**:
+ For the first subject line:
- Use no more than 70 characters.
- - If the changes affect two subsystems, use a comma (and a whitespace) to separate them like `util/codec, util/types:`.
+ - If the changes affect two subsystems, use a comma (and whitespace) to separate them like `util/codec, util/types:`.
- If the changes affect three or more subsystems, you can use `*` instead, like `*:`.
- Use a lowercase letter on the text that immediately follows the colon. For example: "media: **update** the DM architecture image"
- Do not add a period at the end of a commit message.
@@ -75,7 +75,7 @@ Please follow the following style for **all your commits**:
## Pull Request description style
-For Pull Request description in the `Conversation` box, please refer to the following Pull Request description template and include necessary information:
+For the Pull Request description in the `Conversation` box, please refer to the following Pull Request description template and include the necessary information:
```
**What type of PR is this?**
@@ -111,4 +111,4 @@ You may also use the checklist style to list contents if needed. The Markdown sy
For short and obvious Pull Requests, you can omit some of the above information.
-Thanks for your contribution！
\ No newline at end of file
+Thanks for your contribution！
diff --git a/docs/en/MatrixOne/Contribution-Guide/How-to-Contribute/contribute-code.md b/docs/en/MatrixOne/Contribution-Guide/How-to-Contribute/contribute-code.md
index 679bda0bead1b8cd149ea85d8eec1a831f9d68c3..5a278819f928471f1acd843877d2d2eb8ebb8d0d 100644
--- a/docs/en/MatrixOne/Contribution-Guide/How-to-Contribute/contribute-code.md
+++ b/docs/en/MatrixOne/Contribution-Guide/How-to-Contribute/contribute-code.md
@@ -1,13 +1,13 @@
# **Contribute Code**
MatrixOne is an open-source project maintained, improved, and extended by code contributors.
-This document describes the conventions about development workflow, and some styles and templates you need while contributing code to MatrixOne. If you encounter any problem or find some mistakes in participating in contribution to MatrixOne, please [file an issue](https://github.com/matrixorigin/matrixone/issues) in GitHub or contact us on other platforms we support.
+This document describes the conventions of development workflow, and some styles and templates you need while contributing code to MatrixOne. If you encounter any problems or find some mistakes in participating in contribution to MatrixOne, please [file an issue](https://github.com/matrixorigin/matrixone/issues) on GitHub or contact us on other platforms we support.
## **Before Contributions**
-Before you start developing, make sure you have read [Preparation](preparation.md) where you can follow the instructions to learn more about MatrixOne, development knowledge and how to set up the development environment.
+Before you start developing, make sure you have read [Preparation](preparation.md) where you can follow the instructions to learn more about MatrixOne, development knowledge, and how to set up the development environment.
-## **Get familiar with style** <a name="get-familiar-with-style"></a>
+## **Get familiar with the style** <a name="get-familiar-with-style"></a>
It's necessary to keep a consistent style for code, code comments, commit messages, and pull requests when contributing to MatrixOne. When you put together your pull request, we highly recommend you comply with the following style guides which make MatrixOne easy to review, maintain, and develop.
@@ -15,11 +15,11 @@ It's necessary to keep a consistent style for code, code comments, commit messag
The coding style suggested by the Golang community is used in MatrixOne. See the [style doc](https://github.com/golang/go/wiki/CodeReviewComments) for details.
* **Code Comment Style**
-
+
See the [code comment style](../Code-Style/code-comment-style.md) for details.
-* **Commit Message & Pull Request Style**
-
+* **Commit Message & Pull Request Style**
+
See the [Commit Message & Pull Request Style](../Code-Style/code-comment-style.md) for details.
## **Workflow<c name="workflow"></c>**
@@ -39,7 +39,7 @@ And add MatrixOne repo as a remote repository with:
git remote add upstream https://github.com/matrixorigin/matrixone.git
```
-*3.* Create a new branch, the branch name is up to you.
+*3.* Create a new branch. The branch name is up to you.
```
git checkout -b topic-branch
@@ -55,13 +55,13 @@ git push origin main:NEW_BRANCH
*6.* Go back to GitHub, and submit a pull request in `NEW_BRANCH` so that we can review your changes. Add some labels if needed, and don't forget to [refer to the related issue](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue).
-*7.* Once your PR get approved, it would be merged sooner. After merging, synchronize your local repository.
+*7.* Once your PR gets approved, it will be merged sooner. After merging, synchronize your local repository.
```
git pull --force upstream main:main
```
-*8.*Synchronized the `main` branch of your remote repository in Github.
+*8.* Synchronized the `main` branch of your remote repository in Github.
```
git push --force origin main:main
@@ -71,6 +71,6 @@ If you still have some trouble, please refer to [GitHub Docs](https://docs.githu
## **Code review**
-When you open a pull request, you can assign some reviewers, or just leave it blank. And you can add some related labels so that it would be easier to recognize the PR's type/priority/etc. During review, reviewers would comment on your code snippet, and you can modify the code on your topic branch locally, commit the changes, and push to GitHub where the new commits would be attached to the PR automatically.
+When you open a pull request, you can assign some reviewers, or just leave it blank. And you can add some related labels to make it easier to recognize the PR's type/priority/etc. During the review, reviewers would comment on your code snippet, and you can modify the code on your topic branch locally, commit the changes, and push it to GitHub where the new commits would be attached to the PR automatically.
-For detailed code review tips, See [Review a pull request](review-a-pull-request.md) for details.
+For detailed code review tips, See [Review a pull request](review-a-pull-request.md) for details.
diff --git a/docs/en/MatrixOne/Contribution-Guide/How-to-Contribute/contribute-documentation.md b/docs/en/MatrixOne/Contribution-Guide/How-to-Contribute/contribute-documentation.md
index cdee337295c583e19b134cc94a970f888070bffb..5279e59c75dd1b2071c173ae38c90ec1aadc0e54 100644
--- a/docs/en/MatrixOne/Contribution-Guide/How-to-Contribute/contribute-documentation.md
+++ b/docs/en/MatrixOne/Contribution-Guide/How-to-Contribute/contribute-documentation.md
@@ -4,17 +4,17 @@ Contributions to the MatrixOne documentation are welcome from everyone. The Matr
## **Before you start**
-Before you contribute please take a minute to familiarize yourself with basic [Markdown](https://www.markdownguide.org/basic-syntax/) syntax and have a look at our [Code of Conduct](../Code-Style/code-of-conduct.md) and the [Google Developer Documentation Style Guide](https://developers.google.com/style/) for some guidance on how to write accessible, consistent, and inclusive documentation.
+Before you contribute, please take a minute to familiarize yourself with basic [Markdown](https://www.markdownguide.org/basic-syntax/) syntax and look at our [Code of Conduct](../Code-Style/code-of-conduct.md) and the [Google Developer Documentation Style Guide](https://developers.google.com/style/) for some guidance on writing accessible, consistent, and inclusive documentation.
## **How is MatrixOne documentation project organized?**
The MatrixOne documentation is managed in 3 repositories:
-* The main project framework and CI&CD settings are in the [matrixorigin.io](https://github.com/matrixorigin/matrixorigin.io) repo.
+* The main project framework and CI&CD settings are in the [matrixorigin.io](https://github.com/matrixorigin/matrixorigin.io) repo.
-* The markdown contents are in the docs/en/MatrixOne folder of [matrixone](https://github.com/matrixorigin/matrixone) repo.
+* The markdown contents are in the docs/en/MatrixOne folder of [matrixone](https://github.com/matrixorigin/matrixone) repo.
-* The images and unstructured data are located in the [artwork](https://github.com/matrixorigin/artwork) repo.
+* The images and unstructured data are located in the [artwork](https://github.com/matrixorigin/artwork) repo.
The `matrixorigin.io` repo contains a submodule that links to `matrixone` repo contents. The images are referred to as web image links from `artwork` repo. The `matrixorigin.io` has implemented a CI&CD project, which will be triggered by a new code merge and manual launch. This CI&CD workflow publishes the documentation to [https://docs.matrixorigin.io/](https://docs.matrixorigin.io/).
@@ -24,7 +24,7 @@ The documentation project is based on the [mkdocs-material](https://github.com/s
The MatrixOne documentation content is planned with 6 main modules.
-* **Overview**: MatrixOne's introduction, features, architecture, tech design.
+* **Overview**: MatrixOne's introduction, features, architecture.
* **Get Started**: How to quickly deploy and run a MatrixOne in a standalone or a distributed environment.
@@ -42,7 +42,7 @@ The MatrixOne documentation content is planned with 6 main modules.
## **Lift a finger**
-If you are just correcting a typo or grammatical error, feel free to go ahead and [create a pull request](https://github.com/matrixorigin/matrixone/pulls).
+If you are just correcting a typo or grammatical error, feel free to go ahead and [create a pull request](https://github.com/matrixorigin/matrixone/pulls).
### **Contribute Workflow**
@@ -79,9 +79,9 @@ git remote add upstream https://github.com/matrixorigin/matrixorigin.io.git
mkdocs serve
```
-*6*. Make your modification. If the modification is about the project settings, updating the sitemap with new pages, or updating the CI&CD workflow code. You can always check `http://localhost:8000` to see if your modification is effective. If your modification is about the markdown contents, after you update the `docs` submodule of `matrixorigin.io`, the same modifcation should be applied to the `matrixone` repo.
+*6*. Make your modification. If the modification concerns the project settings, update the sitemap with new pages, or update the CI&CD workflow code. You can always check `http://localhost:8000` to see if your modification is effective. If your modification is about the markdown contents, after you update the `docs` submodule of `matrixorigin.io`, the same modification should be applied to the `matrixone` repository.
-*7*. Push your git commits to your remote Github `matrixorigin.io` and `matrixone` repos. We recommend you to push to a new branch using the following commands:
+*7*. Push your git commits to your remote Github `matrixorigin.io` and `matrixone` repos. We recommend you push to a new branch using the following commands:
```
git push origin main:NEW_BRANCH
@@ -89,10 +89,10 @@ git push origin main:NEW_BRANCH
*8*. Go back to GitHub, and submit a pull request in `NEW_BRANCH` so that we can review your changes.
-*9*. Once your code for both repos is merged, you'll wait for a CI&CD workflow to restart running until the documentation website being updated.
+*9*. Once your code for both repositories is merged, you'll wait for a CI&CD workflow to restart running until the documentation website being updated.
!!! note
- So once your pull requests are merged, the update to the website is not immediate. We'll need to run a manual launch to update it.
+ So once your pull requests are merged, the update to the website is not immediate. We'll need to run a manual launch to update it.
*10*. At last, you should update your local and remote repo to help keep committing history clean. Override your local committing repo with:
@@ -111,4 +111,4 @@ git push --force origin main:main
## **Contribute a blog article**
-If you would like to write an article for our blog, please [file an issue](https://github.com/matrixorigin/matrixone/issues/new/choose) or send it to [dengnan@matrixorigin.io](mailto:dengnan@matrixorigin.io). Feel free to submit either a completed draft or any article ideas. All submissions will be reviewed as quickly as possible. If your article or idea seems like a good fit for the blog, we will reach out to you directly.
\ No newline at end of file
+If you would like to write an article for our blog, please [file an issue](https://github.com/matrixorigin/matrixone/issues/new/choose) or send it to [dengnan@matrixorigin.io](mailto:dengnan@matrixorigin.io). Feel free to submit either a completed draft or any article ideas. All submissions will be reviewed as quickly as possible. If your article or idea seems like a good fit for the blog, we will reach out to you directly.
diff --git a/docs/en/MatrixOne/Contribution-Guide/How-to-Contribute/make-a-design.md b/docs/en/MatrixOne/Contribution-Guide/How-to-Contribute/make-a-design.md
index c54dbc0de3c25d047207c90b2f83842d6bd5ef70..f0cde66bbe9a5e9dd2590932a7b1de6934a9cbed 100644
--- a/docs/en/MatrixOne/Contribution-Guide/How-to-Contribute/make-a-design.md
+++ b/docs/en/MatrixOne/Contribution-Guide/How-to-Contribute/make-a-design.md
@@ -1,16 +1,16 @@
# **Make a Design Proposal**
Many changes including bug fixes and documentation improvements, can be implemented and reviewed via the normal GitHub pull request workflow, which we have already introduced in the previous chapter.
-However, when you come up with a new feature you need or expect MatrixOne to achieve, we encourage you to propose your idea and express it as a technique design document.
+However, when you come up with a new feature you need or expect MatrixOne to achieve, we encourage you to propose your idea and express it as a technical design document.
Therefore, this page is intended to guide you to provide a consistent and controlled path for new features to enter the MatrixOne projects, so that all stakeholders can fully understand the direction the project is evolving towards.
This page defines the best practices procedure for making a proposal in MatrixOne projects.
## **Before writing a design document**
-Making enough preparations ahead of the design document can not only promote your working efficiency but increase the likelihood of it being accepted. Oppositely, a rough and casual design document may be rejected quickly.
+Making enough preparations ahead of the design document can promote your working efficiency and increase the likelihood of it being accepted. Oppositely, a rough and casual design document may be rejected quickly.
We motivate you to ask for help from experienced developers in order to obtain valuable suggestions to frame your design architecture or fill in details, which undoubtedly will upgrade the document to be desirable.
-The most common channel for preparing for writing a design document is on the Github issue. You can file a `Feature Request` or `Refactoring Request` to discuss about your ideas.
+The most common channel for preparing for writing a design document is the Github issue. You can file a `Feature Request` or `Refactoring Request` to discuss your ideas.
## **Process**
@@ -19,10 +19,10 @@ Generally, you can follow these steps to finish the whole process:
* Create an issue describing the problem, goal, and solution.
* Get responses from other contributors to see if your proposal is generally acceptable and whether or not you should make some modifications.
* Create a pull request with a design document based on the [design template](https://github.com/matrixorigin/matrixone/blob/main/docs/rfcs/00000000-template.md).
-* Make conversation with reviewers, revise the text in response.
-* The design document is accepted or rejected when at least two committers reach consensus and no objection from the committer.
-* If accepted, create a tracking issue for the design document or convert one from a previous discussion issue. The tracking issue basically tracks subtasks and progress. And refer the tracking issue in the design document replacing placeholder in the template.
+* Make conversation with reviewers, and revise the text in response.
+* The design document is accepted or rejected when at least two committers reach a consensus and there is no objection from the committer.
+* If accepted, create a tracking issue for the design document or convert one from a previous discussion issue. The tracking issue basically tracks subtasks and progress. And refer to the tracking issue in the design document replacing the placeholder in the template.
* Merge the pull request of design.
* Start the implementation.
-Please refer to the tracking issue from subtasks to track the progress.
\ No newline at end of file
+Please refer to the tracking issue from subtasks to track the progress.
diff --git a/docs/en/MatrixOne/Contribution-Guide/How-to-Contribute/preparation.md b/docs/en/MatrixOne/Contribution-Guide/How-to-Contribute/preparation.md
index 4ff072bb401aba8bc9e4a5353a1ab996082cceda..56cf1ec09da7707174c8aa78819aa2bcbe503510 100644
--- a/docs/en/MatrixOne/Contribution-Guide/How-to-Contribute/preparation.md
+++ b/docs/en/MatrixOne/Contribution-Guide/How-to-Contribute/preparation.md
@@ -1,14 +1,14 @@
# **Preparation**
-Before contributing, it's necessary to make some preparations to learn more about MatrixOne and other revalant information which can improve developing and reviewing efficiency.
+Before contributing, it's necessary to make some preparations to learn more about MatrixOne and other prerevalant information which can improve developing and reviewing efficiency.
-Thanks for understanding that English is used as a shared language in this repository. Maintainers do not use machine translation to avoid miscommunication due to errors in translation. If the description of an issue / PR are written in non-English languages, those may be closed. If English is not your native language and you aren't sure about any of these, don't hesitate to ask for help in your pull request!
+Thanks for understanding that this repository uses English as a shared language. Maintainers do not use machine translation to avoid miscommunication due to errors in translation. If the description of an issue / PR is written in non-English languages, it may be closed. If English is not your native language and you aren't sure about any of these, don't hesitate to ask for help in your pull request!
## **What is MatrixOne**
### Basic Information
-You can see [MatrixOne Introduction](../../Overview/matrixone-introduction.md) for key features of MatrixOne, [MatrixOne Architecture](../../Overview/matrixone-architecture.md) for MatrixOne architecture and operational logic. For our distributed framework, see [MatrixCube Tech Design](./../../Overview/matrixcube/matrixcube-introduction.md).
+You can see [MatrixOne Introduction](../../Overview/matrixone-introduction.md) for key features of MatrixOne, [MatrixOne Architecture](../../Overview/matrixone-architecture.md) for MatrixOne architecture, and operational logic.
Besides, you can browse [SQL Reference](../../Reference/SQL-Reference/Data-Definition-Statements/create-database.md) and [Custom Functions](../../Reference/Builtin-Functions/Datetime/year.md) to know more about our interactive details.
@@ -16,9 +16,9 @@ These introductions will help you go through you the key concepts and user detai
### Roadmap
-MatrixOne v0.3.0 has been released, you can see [Release Notes](../../Release-Notes/v0.4.0.md) to know more information.
+MatrixOne v0.3.0 has been released, you can see [Release Notes](../../Release-Notes/v0.4.0.md) know more information.
-Currently, we are working at v0.4.0 and v0.5.0 releases, the job tasks of these releases are listed in the Github milestones [0.4.0](https://github.com/matrixorigin/matrixone/milestone/5).
+Currently, we are working on v0.4.0 and v0.5.0 releases, the job tasks of these releases are listed in the Github milestones [0.4.0](https://github.com/matrixorigin/matrixone/milestone/5).
For the long-term project roadmap, please refer to [MatrixOne roadmap](https://github.com/matrixorigin/matrixone/issues/613) for a more general overview.
@@ -26,7 +26,7 @@ For the long-term project roadmap, please refer to [MatrixOne roadmap](https://g
Contributions to MatrixOne are not limited to writing code. What follows are different ways to participate in the MatrixOne project and engage with our vibrant open-source community. See [Types of Contributions](types-of-contributions.md) for more details.
-* To report a bug or a problem with documentation, please file an [issue](https://github.com/matrixorigin/matrixone/issues/new/choose) providing the details of the problem. Don't forget to add a proper label for your issue, and follow the [issue templates](report-an-issue.md#issue-templates).
+* To report a bug or a problem with the documentation, please file an [issue](https://github.com/matrixorigin/matrixone/issues/new/choose) providing the details of the problem. Don't forget to add a proper label for your issue, and follow the [issue templates](report-an-issue.md#issue-templates).
* To propose a new feature, please file a [new feature request](https://github.com/matrixorigin/matrixone/issues/new/choose). Describe the intended feature and discuss the design and implementation with the team and community. Once the team agrees on the plan, you can follow the [Contribution Workflow](contribute-code.md#workflow) to implement it.
* To implement a feature or bug-fix for an existing outstanding issue, follow the [Contribution workflow](contribute-code.md#workflow). If you need more context on a particular issue, comment on the issue to let people know.
@@ -41,7 +41,7 @@ For contributing code, [matrixone](https://github.com/matrixorigin/matrixone) is
| **optools** | The test and deployment utilities |
| **pkg** | The main codebase of MatrixOne project |
-For different technical modules, a code structure under `/pkg` is as following table. Please refer to [MatrixOne tech design](../../Overview/MatrixOne-Tech-Design/matrixone-techdesign.md) for a better overview.
+For different technical modules, a code structure under `/pkg` is as shown in the following table.
| Directory | Modules |
| ------------------------------ | ------------------------------------------------------------ |
@@ -50,7 +50,6 @@ For different technical modules, a code structure under `/pkg` is as following t
| **sql/** | MPP SQL Execution |
| **sql/vectorize** | Vectorization of SQL Execution |
| **catalog/** | Catalog for storing metadata |
-| **github.com/matrixorigin/matrixcube** | MatrixCube |
| **vm/engine** | Storage engine |
| **vm/engine/aoe** | Analytics Optimized Engine |
| **vm/engine/tpe** | Transaction Processing Engine |
@@ -62,7 +61,7 @@ For contributing documentation, [matrixone](https://github.com/matrixorigin/matr
| ------------------------------ | ------------------------------------------------------------ |
| **matrixone/docs/en/MatrixOne** | The content files of MatrixOne documentation website |
| **matrixone/docs/rfcs** | The design docs of MatrixOne project |
-| **matrixorigin.io/mkdocs.yml** | The configuration file of documentation website |
+| **matrixorigin.io/mkdocs.yml** | The configuration file of the documentation website |
| **artwork/docs** | The images, screenshots and diagrams of documentation webstie |
## **Set up your Development Environment**
diff --git a/docs/en/MatrixOne/Contribution-Guide/How-to-Contribute/report-an-issue.md b/docs/en/MatrixOne/Contribution-Guide/How-to-Contribute/report-an-issue.md
index 248161c77b8c4ad1ae64b34ba0f9cc2992b73b7c..2cb12da137cd4bd60d15108964cee9698425608b 100644
--- a/docs/en/MatrixOne/Contribution-Guide/How-to-Contribute/report-an-issue.md
+++ b/docs/en/MatrixOne/Contribution-Guide/How-to-Contribute/report-an-issue.md
@@ -1,48 +1,48 @@
# **Report Issues**
-Any problem is encouraged to be published when you participate in MatrixOne, and you can [report issues](https://github.com/matrixorigin/matrixone/issues/new/choose) about this problem in GitHub with templates and labels we suggest.
+Any problem is encouraged to be published when you participate in MatrixOne, and you can [report issues](https://github.com/matrixorigin/matrixone/issues/new/choose) about this problem on GitHub with templates and labels we suggest.
This page is intended to introduce templates, labels, and precautions you will follow when you report issues.
## **Avoid Duplicated Issues**
-Before reporting an issue, you should see whether the problem has already been reported. You can use the [search bar](https://docs.github.com/en/issues/tracking-your-work-with-issues/filtering-and-searching-issues-and-pull-requests) to search existing issues.
+Before reporting an issue, you should see whether the problem has already been reported. You can use the [search bar](https://docs.github.com/en/issues/tracking-your-work-with-issues/filtering-and-searching-issues-and-pull-requests) to search for existing issues.
## **Issue Templates**
If the problem you're reporting is not already in the issue tracker, you can file an issue with your GitHub account. MatrixOne uses issue templates for different kinds of issues. Issue templates are a bundle of questions to collect necessary information about the problem to make it easy for other contributors to participate.
MatrixOne suggests 6 types of issue templates:
-A `Bug report` issue template consists of information below:
+A `Bug report` issue template consists of the information below:
* **Detail Environment**
- Describe the details about the operating environment including version, hardware parameters, OS type and so on.
+ Describe the details about the operating environment including version, hardware parameters, OS type, and so on.
* **Steps to Reproduce**
List steps to reproduce what you encountered.
* **Actual & Expected Behavior**
Describe what's the observed and your expected behavior respectively.
-A `Feature Request` consists of information below:
+A `Feature Request` consists of the information below:
* **Is your feature request related to a problem?**
-A clear and concise description of what the problem is and state your reasons why you need this feature.
+A clear and concise description of the problem and state why you need this feature.
* **Describe the feature you'd like:**
A clear and concise description of what you want to happen.
* **Describe alternatives you've considered:**
A clear and concise description of any alternative solutions or features you've considered.
* **Teachability, Documentation, Adoption, Migration Strategy:**
-If you can, explain some scenarios how users might use this, situations it would be helpful in. Any API designs, mockups, or diagrams are also helpful.
+If you can, explain some scenarios in how users might use this, and situations it would be helpful. Any API designs, mockups, or diagrams are also helpful.
-A `Documentation Issue` consists of information below:
+A `Documentation Issue` consists of the information below:
* **Describe the issue**
- A clear and concise description of what's wrong in documentation.
+ A clear and concise description of what's wrong in the documentation.
* **Additional context**
Add any other context about the problem here.
-A `Performance Question` consists of information below:
+A `Performance Question` consists of the information below:
* **Detail Environment**
- Describe the details about the operation environment including version, hardware parameters, OS type and so on.
+ Describe the details about the operating environment including version, hardware parameters, OS type, and so on.
* **Steps to Reproduce**
List steps detailedly to reproduce the operations to test performance.
* **Expected & Actual Performance**
@@ -51,29 +51,29 @@ A `Performance Question` consists of information below:
Add any other context about the problem here. For example:
* Have you compared MatrixOne with other databases? If yes, what's their difference?
-An `Enhancement` consists of information below:
+An `Enhancement` consists of the information below:
* **What would you like to be added**
A concise description of what you're expecting/suggesting.
* **Why is this needed**
A concise description of the reason/motivation.
* **Anything else**
-Anything that will give us more dectail about your issue!
+Anything that will give us more details about your issue!
-A `Refactoring Request` consists of information below:
+A `Refactoring Request` consists of the information below:
* **Is your refactoring request related to a problem?**
A clear and concise description of what the problem is.
* **Describe the solution you'd like**
-A clear and concise description of the refactoring you want to.
+A clear and concise description of the refactoring you want to do.
* **Describe alternatives you've considered**
-A clear and concise description of any alternative solutions or refactoring method you've considered.
+A clear and concise description of any alternative solutions or refactoring methods you've considered.
* **Additional context**
Add any other context or screenshots about the refactoring request here.
A `General Question`:
-If the previous templates don't fit with what you'd like to report or ask, please use this general question template to file issue.
+If the previous templates don't fit with what you'd like to report or ask, please use this general question template to file the issue.
Before asking a question, make sure you have:
@@ -84,10 +84,10 @@ Before asking a question, make sure you have:
## **Issue Labels**
-Once your issue is submitted, it will automatically be labeled with `needs-triage`, a MatrixOne maintainer will look at the issue, tag it with more suitable labels, and assign it to a suitable developer.
-If you'd like to work on the issue by yourself, you can comment `/assign` on the issue you would like to work on, and you will be automatically assigned to the issue. You can then find yourself listed under Assignees section.
+Once your issue is submitted, it will automatically be labeled with `needs-triage`, a MatrixOne maintainer will look at the issue, tag it with more suitable labels, and assign it to a suitable developer.
+If you'd like to work on the issue by yourself, you can comment `/assign` on the issue you would like to work on, and you will be automatically assigned to the issue. You can then find yourself listed under the Assignees section.
## **Good First Issues**
When you make the first contribution to MatrixOne, you can select one of the issues labeled [`good-first-issues`](https://github.com/matrixorigin/matrixone/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22) each of which is relatively approachable for first-time contributors.
-For detailed suggestions you need when you make the first contribution, you can see [Make Your First Contribution](../make-your-first-contribution.md).
+For detailed suggestions, you need when you make the first contribution, you can see [Make Your First Contribution](../make-your-first-contribution.md).
diff --git a/docs/en/MatrixOne/Contribution-Guide/How-to-Contribute/review-a-pull-request.md b/docs/en/MatrixOne/Contribution-Guide/How-to-Contribute/review-a-pull-request.md
index 6dc9dc41b8a6f4eb78f4a99146331c693ab19d98..af8ddce486e7e38c377958aee09c75eff231c8d0 100644
--- a/docs/en/MatrixOne/Contribution-Guide/How-to-Contribute/review-a-pull-request.md
+++ b/docs/en/MatrixOne/Contribution-Guide/How-to-Contribute/review-a-pull-request.md
@@ -1,7 +1,7 @@
# **Reviews**
-For MatrixOne, any type of review for a pull request is crucial, where you can classify the pull request to help look for more suitable experts to solve related problems or propose your suggestions to code for not only contents but style.
-It's not necessary to doubt whether your review is constructive and useful enough because no matter how tiny, a suggestion may make a profound influence on MatrixOne. Certainly, before reviewing we ask that you browse this page to learn basic requirements and relative methods.
+For MatrixOne, any type of review for a pull request is crucial, where you can classify the pull request to help look for more suitable experts to solve related problems or propose your suggestions to code for not only content but style.
+It's not necessary to doubt whether your review is constructive and useful enough because no matter how tiny, a suggestion may profoundly influence MatrixOne. Certainly, before reviewing we ask that you browse this page to learn basic requirements and relative methods.
## **Principles of the code review**
@@ -13,14 +13,14 @@ Be respectful to every pull request author and other reviewers. Code review is a
* **Be careful with tone**
Try to frame your comments as suggestions or questions instead of commands. If the tone is softer, your reviews will be easier to accept.
* **Be generous with your compliments**
-We recommended you offer encouragement and appreciation to the authors for their good practices in the code segments. In many cases, telling the authors what they did is right is even more valuable than telling them what they did is wrong.
+We recommend you offer encouragement and appreciation to the authors for their good practices in the code segments. In many cases, telling the authors what they did is right is even more valuable than telling them what they did is wrong.
Additionally, here are some suggestions in terms of content:
* **Provide more**
We encourage you to provide additional details and context of your review process as much as you can. Undoubtedly, the more detailed your review, the more useful it will be to others. If you test the pull request, please report the result and your test environment details. If you request some changes, try to suggest how.
* **Keep objective**
-Avoid individual biased opinions and subjective emotions. Of course, everyone will comment with more or less subjective opinions, however, as a good reviewer you should consider the technique and data facts rather than your own personal preferences.
+Avoid individual biased opinions and subjective emotions. Of course, everyone will comment with more or less subjective opinions. However, as a good reviewer, you should consider the technique and data facts rather than your own personal preferences.
* **Case by case**
It's difficult to decide whether it's more reasonable to accept or reject when you are faced with a complex problem. Regrettably, we can't provide a certain answer because it always depends on the specific situation, which asks you to balance the pros and cons.
@@ -35,11 +35,11 @@ There are some basic aspects to check when you review a pull request:
* **Concentration**
One pull request should only do one thing. No matter how small it is, the change does exactly one thing and gets it right. Don't mix other changes into it.
* **Tests**
- A pull request should be test covered, whether the tests are unit tests, integration tests, or end-to-end tests. Tests should be sufficient, correct and don't slow down the CI pipeline largely.
+ A pull request should be test covered, whether the tests are unit tests, integration tests, or end-to-end tests. Tests should be sufficient, correct, and don't slow down the CI pipeline largely.
* **Functionality**
- The pull request should implement what the author intends to do, fit well in the existing code base, and resolve a real problem for users. Thus you should check whether or not the pull request achieve the intention and you could follow the discussions in the corresponding [GitHub issue](https://github.com/matrixorigin/matrixone/issues/new/choose).
+ The pull request should implement what the author intends to do, fit well in the existing code base, and resolve a real problem for users. Thus you should check whether or not the pull request achieves the intention and you could follow the discussions in the corresponding [GitHub issue](https://github.com/matrixorigin/matrixone/issues/new/choose).
* **Style**
- Code in the pull request should follow common programming [style](contribute-code.md#get-familiar-with-style). However, sometimes the existing code is inconsistent with the style guide, you should maintain consistency with the existing code or file a new issue to fix the existing code style first.
+ Code in the pull request should follow a common programming [style](contribute-code.md#get-familiar-with-style). However, sometimes the existing code is inconsistent with the style guide. You should maintain consistency with the existing code or file a new issue to fix the existing code style first.
* **Documentation**
If a pull request changes how users build, test, interact with, or release code, you must check whether it also updates the related documentation such as `README.md` and any generated reference docs. Similarly, if a pull request deletes or deprecates code, you must check whether or not the corresponding documentation should also be deleted.
* **Performance**
diff --git a/docs/en/MatrixOne/Contribution-Guide/make-your-first-contribution.md b/docs/en/MatrixOne/Contribution-Guide/make-your-first-contribution.md
index cd76e6589133ff1bf0564d73e28da63def92ff8e..2eba7e4d6cfc62437d8adbe437e77c5a1faf7828 100644
--- a/docs/en/MatrixOne/Contribution-Guide/make-your-first-contribution.md
+++ b/docs/en/MatrixOne/Contribution-Guide/make-your-first-contribution.md
@@ -6,7 +6,7 @@ This document will help you get started on your first contribution to MatrixOne.
## **How to Contribute?**
-Before setting about contribution, you need figure out what area you are trying to help us in. You can see [Types of contributions](How-to-Contribute/types-of-contributions.md) for more details.
+Before setting out contributions, you need to figure out what area you are trying to help us in. You can see [Types of contributions](How-to-Contribute/types-of-contributions.md) for more details.
As your first-ever contribution, it can be selected from the following categories which require little technical background of the contributor:
@@ -14,16 +14,16 @@ As your first-ever contribution, it can be selected from the following categorie
* To improve the MatrixOne documentation
-File an issue to describe the problem before working on it. In addition, you will also find issues labelled with `good-first-issue`, which represents issues suitable for new contributors. Such Issues contain clear steps and expected output. You may start your first contribution based on these issues.
+File an issue to describe the problem before working on it. In addition, you will also find issues labeled with `good-first-issue`, which represents issues suitable for new contributors. Such Issues contain clear steps and expected output. You may start your first contribution based on these issues.
## **Assign Your Issue**
It's difficult to report an issue when you are just a newcomer on account of little knowledge of MatrixOne or relative contents, so we list [`good-first-issues`](https://github.com/matrixorigin/matrixone/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22) suitable for new contributors to work with and be easy to fix.
-After deciding a suitable issue to work on, you can comment `/assign` on the issue you would like to work on, you will be automatically assigned to the issue. You can then find yourself listed under Assignees section.
+After deciding on a suitable issue to work on, you can comment `/assign` on the issue you would like to work on, and you will be automatically assigned to the issue. You can then find yourself listed under the Assignees section.
## **Prerequisite**
-Before working on the issue you are assigned, please make sure you have set up development environment and installed MatrixOne.
+Before working on the issue you are assigned, please make sure you have set up a development environment and installed MatrixOne.
You can see [Preparation](How-to-Contribute/preparation.md) for more details.
## **Workflow**
@@ -83,7 +83,7 @@ git add <filename>
```
`<filename>` is the name of the file you just modified.
-And you can use following command to add all the files in the current folder:
+And you can use the following command to add all the files in the current folder:
```
git add .
@@ -106,11 +106,11 @@ After committing your modification, you should push your local branch to GitHub
git push origin main:NEW_BRANCH
```
-`NEW_BRANCH` is the name of new branch you created and push to. Also, you can replace it with another name you want.
+`NEW_BRANCH` is the name of the new branch you created and push to. Also, you can replace it with another name you want.
### **Step 7 Create a pull request**
-Having pushed your changes, you can visit your folk at `https://github.com/$user/matrixone`, and click the **Compare & Pull Request** button to create a pull request in `NEW_BRANCH` for your modification to the MatrixOne repository.
+Having pushed your changes, you can visit your folk at `https://github.com/$user/matrixone`, and click the **Compare & Pull Request** button to create a pull request in `NEW_BRANCH` for your modification to the MatrixOne repository.
!!! Note
You should fill in the required information based on the PR template.
@@ -118,13 +118,13 @@ Having pushed your changes, you can visit your folk at `https://github.com/$user
-Once your PR is opened, it will be assigned to reviewers. These reviewers will check your contribution and make a detail review according to correctness, bugs, style and so on.
+Once your PR is opened, it will be assigned to reviewers. These reviewers will check your contribution and do a detailed review according to the correctness, bugs, style, sand so on.
### **Step 8 After merging, Keep your repo in sync**
-Congratulations on that your contributions are accepted and merged to the project!
-And there are some operations left to do, which helps keep project committing history clean and keep your local and remote repo synchronized with MatrixOne repo.
-Overrides local commiting history with following command:
+Congratulations that your contributions are accepted and merged into the project!
+And there are some operations left to do, which help keep project committing history clean and keep your local and remote repo synchronized with MatrixOne repo.
+Overrides local committing history with the following command:
```
git pull --force upstream main:main
@@ -134,4 +134,4 @@ Lastly, upgrade the `main` branch of your folk in Github:
```
git push --force origin main:main
-```
\ No newline at end of file
+```
diff --git a/docs/en/MatrixOne/Develop/develop_python_application.md b/docs/en/MatrixOne/Develop/develop_python_application.md
index 398e3989d93d109bc0c2299bc9ef0a042a2e8b38..eba5422bce497ad2952df627634fd731cbfe8c89 100644
--- a/docs/en/MatrixOne/Develop/develop_python_application.md
+++ b/docs/en/MatrixOne/Develop/develop_python_application.md
@@ -6,36 +6,36 @@ This tutorial shows you how to build a simple Python application with MatrixOne.
This demo will store the historical stock data of the China stock market and make a simple analysis to find the best stocks to buy.
-The basic idea is that we track the P/E (Price-to-Earnings) and P/B (Price-to-Book) level of each stock since these can represent a company's market capitalization. If you are not familiar with these two concepts, please refer to [P/E](https://www.investopedia.com/terms/p/price-earningsratio.asp) and [P/B](https://www.investopedia.com/terms/p/price-to-bookratio.asp).
+The basic idea is that we track the P/E (Price-to-Earnings) and P/B (Price-to-Book) levels of each stock since these can represent a company's market capitalization. If you are not familiar with these two concepts, please refer to [P/E](https://www.investopedia.com/terms/p/price-earningsratio.asp) and [P/B](https://www.investopedia.com/terms/p/price-to-bookratio.asp).
-Every day after the market closes, we compare the P/E and P/B value with the historical lowest P/E and P/B. If the current P/E or P/B is even lower than the historical lowest, the stock is very likely under-estimated. We can further investigate its reason of falling and judge if it's a good time to buy it.
+Every day after the market closes, we compare the P/E and P/B values with the historical lowest P/E and P/B. If the current P/E or P/B is even lower than the historical lowest, the stock is very likely underestimated. We can further investigate its reason for falling and judge if it's a good time to buy it.
## **Before you start**
Before you start, you need to have a Tushare account and get an API token. If you haven't signed up for Tushare, you can sign up for it at [https://tushare.pro/](https://tushare.pro/) and you can find your API token at [https://tushare.pro/user/token#](https://tushare.pro/user/token#).
-!!! info
- Tushare is an open source utility for crawling historical data of China stocks. It has a complete dataset, but pay attention to their rules of API access limit and frequency.
+!!! info
+ Tushare is an open-source utility for crawling historical data of China stocks. It has a complete dataset, but pay attention to their rules of API access limit and frequency.
-Besides the data source account, you need to at least have these two basic software installed:
+Besides the data source account, you need to at least have this two basic software installed:
-* Python 3.x
+* Python 3.x
* MatrixOne
You may refer to [Python 3 installation tutorial](https://realpython.com/installing-python/) and [MatrixOne installation](../Get-Started/install-standalone-matrixone.md) for more details.
-Moreover, we need to install dependant `Tushare` and `pymysql` python libraries to use Tushare and access MatrixOne.
+Moreover, we need to install dependent `Tushare` and `pymysql` python libraries to use Tushare and access MatrixOne.
```bash
pip3 install -r requirements.txt
```
-!!! info
+!!! info
`Pymysql` is the only ORM tool supported by MatrixOne. The other python MySQL ORM tools as `SQLAlchemy`, `mysql-connector`, `MySQLdb` are not supported yet.
-## **Step1: prepare and load historical dataset**
+## **Step1: prepare and load the historical dataset**
-First, we need to load the historical stock data in MatrixOne.
+First, we need to load the historical stock data in MatrixOne.
As `Tushare` interface only allows a fetch of 5000 rows of data at once, we only have to collect the latest 5000 trade days data for each stock. Each year there are roughly 250 trade dates. 5000 makes almost 20 years of data, which largely satisfies our demo.
@@ -54,7 +54,7 @@ pool = pro.stock_basic(exchange = '',
list_status = 'L',
adj = 'qfq',
fields = 'ts_code,symbol,name,area,industry,fullname,list_date, market,exchange,is_hs')
-
+
```
@@ -95,7 +95,7 @@ mysql> CREATE DATABASE stock.
```
-Python:
+Python:
```
import pymysql
@@ -106,12 +106,12 @@ db = pymysql.connect(host='127.0.0.1',
user='dump',
password='111',
database='stock')
-
+
# Create a cursor object
cursor = db.cursor()
# Create PE table
-cursor.execute('CREATE TABLE IF NOT EXISTS pe(ts_code VARCHAR(255), trade_date VARCHAR(255), pe FLOAT, pb FLOAT)')
+cursor.execute('CREATE TABLE IF NOT EXISTS pe(ts_code VARCHAR(255), trade_date VARCHAR(255), pe FLOAT, pb FLOAT)')
```
@@ -124,12 +124,12 @@ if df.empty == False:
df = df.fillna(0.0)
val_to_insert = df.values.tolist()
cursor.executemany(" insert into pe (ts_code, trade_date,pe,pb) values (%s, %s,%s,%s)", val_to_insert)
-
+
```
## **Step2: find the historical lowest P/E or P/B stock**
-After we load the historical stock data into MatrixOne, we have about 11 millions records.
+After we load the historical stock data into MatrixOne, we have about 11 million records.
```sql
mysql> select count(*) from pe;
@@ -141,18 +141,18 @@ mysql> select count(*) from pe;
1 row in set (0.16 sec)
```
-Now we run a sql to calculate the lowest P/E and P/B of each stock.
+Now we run a SQL to calculate the lowest P/E and P/B of each stock.
```python
# Find stocks that the current P/E is even lower than the historical lowest
cursor.execute('select ts_code,min(pe) from pe where pe>0 group by ts_code order by ts_code')
# Fetch the result as python object
-value = cursor.fetchall()
+value = cursor.fetchall()
# Find stocks that the current P/B is even lower than the historical lowest
cursor.execute('select ts_code,min(pb) from pe where pb>0 group by ts_code order by ts_code')
# Fetch the result as python object
-value = cursor.fetchall()
+value = cursor.fetchall()
```
Then we call Tushare `daily_basic` interface again to get the current P/E and P/B level and make a search to locate the stock whose current P/E or P/B is even lower than the historical lowest. You could of course switch any trade date you want for comparison. We take P/E as an example.
@@ -181,13 +181,13 @@ for i in range(0,len(value)):
logging.getLogger().info("current PE found: %f", df.pe[j])
```
-This will print every stock with the lowest ever P/E or P/B. They are usually good choices to buy if they are not experiencing big trouble.
+This will print every stock with the lowest ever P/E or P/B. They are usually good choices to buy if they are not experiencing big trouble.
## **Step3: Update our dataset**
-We already have a lot of historical data stored in MatrixOne, each time we run a n analysis, we usually have been through a new trading day. The dataset need to be updated with the latest data, otherwise next time you will still compare yourself with the old data.
+We already have a lot of historical data stored in MatrixOne; each time we run an analysis, we usually have been through a new trading day. The dataset needs to be updated with the latest data, otherwise next time you will still compare yourself with the old data.
-We don't need to insert all data again, we just insert the data with the lastest trading dates.
+We don't need to insert all data again, we just insert the data with the latest trading dates.
```python
# get updating trading dates by user argument inputs
@@ -211,9 +211,9 @@ if df.empty == False:
val_to_insert = df.values.tolist()
print(val_to_insert)
cursor.executemany(" insert into pe (ts_code, trade_date,pe,pb) values (%s, %s,%s,%s)", val_to_insert)
-
-```
+
+```
## Source Code
-You can find the source code of this demo at [matrix_one_app](https://github.com/matrixorigin/matrixone_python_app).
\ No newline at end of file
+You can find the source code of this demo at [matrix_one_app](https://github.com/matrixorigin/matrixone_python_app).
diff --git a/docs/en/MatrixOne/FAQs/deployment-faqs.md b/docs/en/MatrixOne/FAQs/deployment-faqs.md
index c85f014ade3f5b3a7caeea642d8d6e6c524e32b5..860c14827d346d1b50654d0b4aa523b544be59ca 100644
--- a/docs/en/MatrixOne/FAQs/deployment-faqs.md
+++ b/docs/en/MatrixOne/FAQs/deployment-faqs.md
@@ -32,7 +32,7 @@ For standalone installation, MatrixOne 0.5.0 can be running on the 64-bit generi
| :------ | :----- | :-------------- |
| 4 core+ | 16 GB+ | SSD/HDD 200 GB+ |
-The Macbook M1/M2 with ARM architecture is also a good fit for development environment.
+The Macbook M1/M2 with ARM architecture is also a good fit for a development environment.
##### Production environment
@@ -60,7 +60,7 @@ Then the `make build` should be fast enough to finish.
##### When I was testing MatrixOne with MO-tester, I got an error of `too many open files`?
-MO-tester will open and close many SQL files in a high speed to test MatrixOne, this kind of usage will easily reach the maximum open file limit of Linux and MacOS, which is the reason for the `too many open files` error.
+MO-tester will open and close many SQL files in a high speed to test MatrixOne, this kind of usage will easily reach the maximum open file limit of Linux and macOS, which is the reason for the `too many open files` error.
* For MacOS, you can just set the open file limit by a simple command:
diff --git a/docs/en/MatrixOne/FAQs/product-faqs.md b/docs/en/MatrixOne/FAQs/product-faqs.md
index 908ceffd9c03d38e30a566032214eb95737e9a6d..d8be13a0ebb7d874aadb73c109b0c1a708839f70 100644
--- a/docs/en/MatrixOne/FAQs/product-faqs.md
+++ b/docs/en/MatrixOne/FAQs/product-faqs.md
@@ -2,7 +2,7 @@
* **What is MatrixOne?**
- MatrixOne is a future-oriented hyperconverged cloud & edge native DBMS that supports transactional, analytical, and streaming workload with a simplified and distributed database engine, across multiple datacenters, clouds, edges and other heterogenous infrastructures. The all-in-one architecture of MatrixOne will significantly simplify database management and maintenance, creating a single database that can serve multiple data applications.
+ MatrixOne is a future-oriented hyperconverged cloud & edge native DBMS that supports transactional, analytical, and streaming workload with a simplified and distributed database engine, across multiple data centers, clouds, edges, and other heterogenous infrastructures. The all-in-one architecture of MatrixOne will significantly simplify database management and maintenance, creating a single database that can serve multiple data applications.
For information about MatrixOne, you can see [MatrixOne Introduction](../Overview/matrixone-introduction.md).
* **Where can I apply MatrxOne?**
@@ -14,17 +14,17 @@
MatrixOne is a completely redesigned database. It's compatible with part of MySQL syntax and semantics. We are currently working to support more database semantics such as PostgreSQL, Hive, Clickhouse, since we intend to develop MatrixOne as a hyperconverged database.
To learn more about the compatibility with MySQL, you can visit [MySQL-Compatibility](../Overview/mysql-compatibility.md).
-* **Which programming language is MatrixOne developed with ?**
+* **Which programming language is MatrixOne developed with?**
- Currently, the primary programming language used for our programming is **Golang**.
+ Currently, the primary programming language used for our programming in **Golang**.
* **What operating system does MatrixOne support?**
- MatrixOne supports Linux and MacOS. Please refer to [deployment FAQ](deployment-faqs.md) for more details.
+ MatrixOne supports Linux and macOS. Please refer to [deployment FAQ](deployment-faqs.md) for more details.
* **Which MatrixOne data types are supported?**
- You can see [data tpyes in MatrixOne](../Reference/Data-Types/data-types.md) to learn more about the data types we support.
+ You can see [data types in MatrixOne](../Reference/Data-Types/data-types.md) to learn more about the data types we support.
* **Where can I deploy MatrixOne?**
@@ -36,4 +36,4 @@
* **In addition to the MatrixOne documentation, are there any other ways to acquire MatrixOne knowledge?**
- Currently [MatrixOne documentation](https://docs.matrixorigin.io/) is the most important and timely way to get MatrixOne related knowledge. In addition, we also have some technical communication groups in Slack and WeChat. If you have any needs, contact [opensource@matrixorigin.io](mailto:opensource@matrixorigin.io).
+ Currently, [MatrixOne documentation](https://docs.matrixorigin.io/) is the most important and timely way to get MatrixOne related knowledge. In addition, we also have some technical communication groups in Slack and WeChat. If you have any needs, contact [opensource@matrixorigin.io](mailto:opensource@matrixorigin.io).
diff --git a/docs/en/MatrixOne/FAQs/sql-faqs.md b/docs/en/MatrixOne/FAQs/sql-faqs.md
index a21a660f10987b35301bc3c7c162b266cc12038e..eb3c3e98c0f549d7bad1543736ec66ee45dbf84c 100644
--- a/docs/en/MatrixOne/FAQs/sql-faqs.md
+++ b/docs/en/MatrixOne/FAQs/sql-faqs.md
@@ -2,7 +2,7 @@
* **Are functions and other keywords case sensitive？**
- No, they are not case sensitive. Only in one case case is sensitive in MatrixOne, if user creates table and attributes with ``, the name in`` is case sensitive. To find this table name or attribute name in your query, it needs to be in `` as well.
+ No, they are not case sensitive. Only in one case case is sensitive in MatrixOne, if user creates table and attributes with \`\`, the name in\`\` is case sensitive. To find this table name or attribute name in your query, it needs to be in \`\` as well.
* **How do I export data from MatrixOne to a file?**
@@ -11,7 +11,7 @@
* **What is the size limit of a transaction in MatrixOne?**
- The transaction size is limited to the memory size you have for hardware environment.
+ The transaction size is limited to the memory size you have for hardware environment.
* **What kind of character set does MatrixOne support?**
@@ -23,7 +23,7 @@
* **How do I bulk load data into MatrixOne?**
- MatrixOne provides two methods of bulk load data: 1. Using `source filename` command from shell, user can load the SQL file with all DDL and insert data statements. 2. Using `load data infile...into table...` command from shell, user can load an existing .csv file to MatrixOne.
+ MatrixOne provides two methods of bulk load data: 1. Using `source filename` command from shell, user can load the SQL file with all DDL and insert data statements. 2. Using `load data infile...into table...` command from shell, user can load an existing .csv file to MatrixOne.
* **How do I know how my query is executed?**
@@ -31,4 +31,4 @@
```
EXPLAIN SELECT col1 FROM tbl1;
- ```
\ No newline at end of file
+ ```
diff --git a/docs/en/MatrixOne/Get-Started/connect-to-matrixone-server.md b/docs/en/MatrixOne/Get-Started/connect-to-matrixone-server.md
index 82ef84866006d990dbf4687b6063c257bd95d1f2..bab36029bca6fd3fef7921434f63bc91ecff536d 100644
--- a/docs/en/MatrixOne/Get-Started/connect-to-matrixone-server.md
+++ b/docs/en/MatrixOne/Get-Started/connect-to-matrixone-server.md
@@ -5,10 +5,10 @@
Make sure you have already [installed MatrixOne](install-standalone-matrixone.md).
## **1. Install MySQL client**
-
-MatrixOne supports the MySQL wire protocol, so you can use MySQL client drivers to connect from various languages.
-Currently, MatrixOne is only compatible with Oracle MySQL client. This means that some features might not work with MariaDB client or Percona client.
+MatrixOne supports the MySQL wire protocol, so you can use MySQL client drivers to connect from various languages.
+
+Currently, MatrixOne is only compatible with the Oracle MySQL client. This means that some features might not work with the MariaDB client or Percona client.
## **2. Connect to MatrixOne server**
@@ -18,7 +18,7 @@ You can use the MySQL command-line client to connect to MatrixOne server:
mysql -h IP -P PORT -uUsername -p
```
-The connection string is the same format as MySQL accepts. You need to provide a user name and a password.
+The connection string is the same format as MySQL accepts. You need to provide a user name and a password.
Use the built-in test account for example:
@@ -30,4 +30,4 @@ mysql -h 127.0.0.1 -P 6001 -udump -p
Enter password:
```
-Currently, MatrixOne only supports the TCP listener.
\ No newline at end of file
+Currently, MatrixOne only supports the TCP listener.
diff --git a/docs/en/MatrixOne/Get-Started/install-standalone-matrixone.md b/docs/en/MatrixOne/Get-Started/install-standalone-matrixone.md
index 4a83254a5900161a2dfa7a06de35faa427cf9851..8063cf06aeca1bc84bd7360a17421e619874e58c 100644
--- a/docs/en/MatrixOne/Get-Started/install-standalone-matrixone.md
+++ b/docs/en/MatrixOne/Get-Started/install-standalone-matrixone.md
@@ -1,8 +1,8 @@
# **Install standalone MatrixOne**
-MatrixOne supports Linux and MacOS. You can install a standalone MatrixOne version by 3 methods:
+MatrixOne supports Linux and macOS. You can install a standalone MatrixOne version by 3 methods:
-* Building from source.
+* Building from the source.
* Using binary package.
* Using Docker.
@@ -10,7 +10,7 @@ Recommended hardware specification: x86 CPU with 4 cores and 32GB memory, with C
## **Method 1: Building from source**
-#### 1. Install Go as necessary dependancy
+#### 1. Install Go as necessary dependency
Go version 1.18 is required.
@@ -20,7 +20,7 @@ Depending on your needs, choose whether you want to keep your code up to date, o
##### Option 1: Get the MatrixOne(Preview Version) code
-The **main** branch is the default branch, the code on the main branch is always up-to-date but not stable enough.
+The **main** branch is the default branch. The code on the main branch is always up-to-date but not stable enough.
```
git clone https://github.com/matrixorigin/matrixone.git
@@ -71,14 +71,14 @@ wget https://github.com/matrixorigin/matrixone/releases/download/v0.5.0/mo-serve
unzip mo-server-v0.5.0-linux-amd64.zip
```
-MacOS Environment
+macOS Environment
```bash
wget https://github.com/matrixorigin/matrixone/releases/download/v0.5.0/mo-server-v0.5.0-darwin-x86_64.zip
unzip mo-server-v0.5.0-darwin-x86_64.zip
```
-#### 2.Launch MatrixOne server
+#### 2. Launch MatrixOne server
```
$./mo-server system_vars_config.toml
@@ -94,7 +94,7 @@ See [Connect to MatrixOne server](connect-to-matrixone-server.md).
#### 1. Install Docker
-Please verify that Docker daemon is running in the background:
+Please verify that the docker daemon is running in the background:
```
docker --version
@@ -102,7 +102,7 @@ docker --version
#### 2. Create and run the container of MatrixOne
-It will pull the image from Docker Hub if not exists. You can choose to pull the latest image or a stable version.
+It will pull the image from Docker Hub if it does not exist. You can choose to pull the latest image or a stable version.
Latest Image
@@ -116,7 +116,7 @@ docker run -d -p 6001:6001 --name matrixone matrixorigin/matrixone:latest
docker run -d -p 6001:6001 --name matrixone matrixorigin/matrixone:0.5.0
```
-For the information on the user name and password, see the next step - Connect to MatrixOne Server.
+For the user name and password information, see the next step - Connect to MatrixOne Server.
#### 3. Connect to MatrixOne Server
diff --git a/docs/en/MatrixOne/Overview/matrixone-architecture.md b/docs/en/MatrixOne/Overview/matrixone-architecture.md
index 0f119d152c8e1f9dc092a28f93b588717f0e7963..f90ae479607bad7eb1998f49cb0030b35d706507 100644
--- a/docs/en/MatrixOne/Overview/matrixone-architecture.md
+++ b/docs/en/MatrixOne/Overview/matrixone-architecture.md
@@ -2,20 +2,19 @@
## **Architecture**
-MatrixOne is the first open-source distributed HSTAP database that supports OLTP, OLAP and Streaming with a single auto-tuning storage engine.
-As a redefinition of HTAP database, HSTAP aims to meet all the needs of Transactional Processing (TP) and Analytical Processing (AP) within a single database. Compared with the traditional HTAP, HSTAP emphasizes its built-in streaming capability used for connecting TP and AP tables. This provides users with an experience that database can be used just like a Big Data platform, with which many users are already familiar thanks to the Big Data boom.
+MatrixOne is the first open-source distributed HSTAP database that supports OLTP, OLAP, and Streaming with a single auto-tuning storage engine.
+As a redefinition of the HTAP database, HSTAP aims to meet all the needs of Transactional Processing (TP) and Analytical Processing (AP) within a single database. Compared with the traditional HTAP, HSTAP emphasizes its built-in streaming capability used for connecting TP and AP tables. This provides users with an experience that a database can be used just like a Big Data platform, with which many users are already familiar thanks to the Big Data boom.
-With minimal integration efforts, MatrixOne frees users from the limitations of Big Data and provides one-
-stop coverage for all TP and AP scenarios for enterprises.
+With minimal integration efforts, MatrixOne frees users from the limitations of Big Data and provides one-stop coverage for all TP and AP scenarios for enterprises.
-MatrixOne is redesigned from scratch and introducing many innovations as well as many best practices in the other DBMS. It adopts a disaggregated storage and compute architecture, where data are stored on S3 object storage in the cloud to achieve low cost, and the compute nodes are stateless and can be started at will to achieve the ultimate elasticity. In the case of on-premises deployment, when available, MatrixOne can utilize user's HDFS or other supported distributed file system to save data. MatrixOne also comes with a S3-compatible built-in alternative to ensure the elasticity, high reliability, and high performance of its storage without relying on any external components. The architecture is as follows:
+MatrixOne is redesigned from scratch and introduces many innovations as well as many best practices in the other DBMS. It adopts a disaggregated storage and computes architecture, where data are stored on S3 object storage in the cloud to achieve low cost, and the compute nodes are stateless and can be started at will to achieve the ultimate elasticity. In the case of on-premises deployment, MatrixOne can utilize the user's HDFS or other supported distributed file system to save data. MatrixOne also comes with an S3-compatible built-in alternative to ensure the elasticity, high reliability, and high performance of its storage without relying on any external components. The architecture is as follows:
The architecture of MatrixOne is divided into several layers:
## **Cluster Management Layer**
-Being responsible for cluster management, it interacts with Kubernetes to obtain resources dynamically when in the cloud-native environment, while in the on-premises deployment, it gets hold of resources based on the configuration. Cluster status is continuously monitored with the role of each node allocated based on resource information. Maintenance works are carried out to ensure that all system components are up and running despite occasional node and network failures, it rebalances the loads on nodes when necessary as well. Major components in this layer are:
+Being responsible for cluster management, it interacts with Kubernetes to obtain resources dynamically when in the cloud-native environment, while in the on-premises deployment, it gets hold of resources based on the configuration. Cluster status is continuously monitored with the role of each node allocated based on resource information. Maintenance works are carried out to ensure that all system components are up and running despite occasional node and network failures. It rebalances the loads on nodes when necessary as well. Major components in this layer are:
* Prophet Scheduler: take charge of load balancing and node keep-alive.
* Resource Manager: being responsible for physical resources provision.
@@ -25,12 +24,12 @@ Being responsible for cluster management, it interacts with Kubernetes to obtain
Serverless Layer is a general term for a series of stateless nodes, which, as a whole, contains three categories:
* Background tasks: the most important one is called Offload Worker, which is responsible for offloading expensive compaction tasks and flushing data to S3 storage.
-* SQL compute nodes: responsible for executing SQL requests, here divided into write nodes and read nodes, the former also provides the ability to read the freshest data.
+* SQL compute nodes: responsible for executing SQL requests, here divided into write nodes and read nodes. The former also provides the ability to read the freshest data.
* Stream task processing node: responsible for executing stream processing requests.
## **Log(Reliability) Layer**
-As MatrixOne's Single Source of Truth, data is considered as persistently stored in MatrixOne once it is written into the Log Layer. It is built upon our world-class expertise in the Replicated State Machine model to guarantee state-of-the-art high throughput, high availability and strong consistency for our data. Following a fully modular and disaggregated design by itself, it is also the central component that helps to decouple the storage and compute layers, this in turn earns our architecture much higher elasticity when compared with traditional NewSQL architecture.
+As MatrixOne's Single Source of Truth, data is considered as persistently stored in MatrixOne once it is written into the Log Layer. It is built upon our world-class expertise in the Replicated State Machine model to guarantee state-of-the-art high throughput, high availability, and strong consistency for our data. Following a fully modular and disaggregated design by itself, it is also the central component that helps to decouple the storage and compute layers. This in turn earns our architecture much higher elasticity when compared with traditional NewSQL architecture.
## **Storage Layer**
@@ -38,13 +37,12 @@ The storage layer transforms the incoming data from the Log Layer into an effici
## **Storage Provision Layer**
-As an infrastructure agnostic DBMS, MatrixOne stores data in shared storage of S3 / HDFS, or local disks, on-premise servers, hybrid and any cloud, or even smart devices. The Storage Provision Layer hides such complexity from upper layers by just presenting them with a unified interface for accessing such diversified storage resources.
+As an infrastructure agnostic DBMS, MatrixOne stores data in shared storage of S3 / HDFS, or local disks, on-premise servers, hybrid, and any cloud, or even smart devices. The Storage Provision Layer hides such complexity from upper layers by just presenting them with a unified interface for accessing such diversified storage resources.
## **Learn More**
This page outlines the overall architecture design of MatrixOne. For information on other options that are available when trying out MatrixOne, see the following:
-* [MatrixOne Tech Design](MatrixOne-Tech-Design/matrixone-techdesign.md)
* [Install MatrixOne](../Get-Started/install-standalone-matrixone.md)
* [MySQL Compatibility](mysql-compatibility.md)
-* [What's New](whats-new.md)
\ No newline at end of file
+* [What's New](whats-new.md)
diff --git a/docs/en/MatrixOne/Overview/matrixone-introduction.md b/docs/en/MatrixOne/Overview/matrixone-introduction.md
index 077d29a0b3294d3df6ed4806ce613f4d61144f0a..a1e141bf400e1678e3d8331533314f7b7cdb415b 100644
--- a/docs/en/MatrixOne/Overview/matrixone-introduction.md
+++ b/docs/en/MatrixOne/Overview/matrixone-introduction.md
@@ -42,7 +42,7 @@ MatrixOne is a future-oriented hyperconverged cloud & edge native DBMS that supp
* **Simplify Database Management and Maintenance**
- To solve the problem of high and unpredictable costs of the database selection process, management & maintenance due to database overabundance, MatrixOne's all-in-one architecture will significantly simplify database management and maintenance, a single database can serve multiple data applications.
+ To solve the problem of high and unpredictable costs of the database selection process, management & maintenance due to database overabundance, MatrixOne's all-in-one architecture will significantly simplify database management and maintenance. A single database can serve multiple data applications.
* **Reduce Data Fragmentation and Inconsistency**
@@ -69,4 +69,3 @@ MatrixOne is a future-oriented hyperconverged cloud & edge native DBMS that supp
This page outlines the overall introduction of MatrixOne. For information on other options that are available when you what to know more about MatrixOne product design, see the following:
* [MatrixOne Architecture](matrixone-architecture.md)
-* [MatrixOne Tech Design](MatrixOne-Tech-Design/matrixone-techdesign.md)
diff --git a/docs/en/MatrixOne/Test/mo-tester.md b/docs/en/MatrixOne/Test/mo-tester.md
index b02e55c0e90a11a50bc53662a9bbcfe30e8ac96f..a449f6cb318bc6abb96a6a31479741b1d448b9fc 100644
--- a/docs/en/MatrixOne/Test/mo-tester.md
+++ b/docs/en/MatrixOne/Test/mo-tester.md
@@ -12,7 +12,7 @@ MO-Tester content locations:
* *Result*: <https://github.com/matrixorigin/mo-tester/tree/main/result>
-* *Report*: once finished running, a `mo-tester/report` will be generated in local directory.
+* *Report*: once finished running, a `mo-tester/report` will be generated in the local directory.
The Cases and Results are 1-1 correspondence, and they are actually `git submodules` from MatrixOne repository. Adding new cases and results should be in MatrixOne repo: <https://github.com/matrixorigin/matrixone/tree/main/test>
@@ -35,7 +35,7 @@ MO-Tester includes testing cases in the following table.
# How to use MO-Tester?
-## 1. Prepare testing environment
+## 1. Prepare the testing environment
* Make sure you have installed jdk8.
@@ -114,7 +114,8 @@ Note: every time running `run.sh` will overwrite the `error`, `report`, and `suc
* An example of `report.txt` looks like this:
-```[SUMMARY] TOTAL : 486, SUCCESS : 486, ERROR :0, NOEXE :0, SUCCESS RATE : 100%
+```
+[SUMMARY] TOTAL : 486, SUCCESS : 486, ERROR :0, NOEXE :0, SUCCESS RATE : 100%
[SUMMARY] TOTAL : 486, SUCCESS : 485, ERROR :1, NOEXE :0, SUCCESS RATE : 99%
[cases/transaction/atomicity.sql] TOTAL : 67, SUCCESS : 66, ERROR :1, NOEXE :0, SUCCESS RATE : 98%
[cases/transaction/isolation.sql] TOTAL : 202, SUCCESS : 202, ERROR :0, NOEXE :0, SUCCESS RATE : 100%
diff --git a/docs/en/MatrixOne/glossary.md b/docs/en/MatrixOne/glossary.md
index 8027645f9b3bdc32db1e6621e416d8c2687aa002..c25b837d60d677d65dec3e020030507f7395e879 100644
--- a/docs/en/MatrixOne/glossary.md
+++ b/docs/en/MatrixOne/glossary.md
@@ -11,7 +11,7 @@ It's helpful to understand a few terms before reading our architecture documenta
| C | |
| Cluster | A distributed MatrixOne deployment, which acts as a single logical application.|
| D | |
- | Data Storage | A DataStorage is an interface for implementing distributed storage service. It must be defined in prior to using MatrixCube. DataStorage needs to be implemented based on the characteristics of storage engine.|
+ | Data Storage | A DataStorage is an interface for implementing distributed storage service. <!--It must be defined in prior to using MatrixCube.--> DataStorage needs to be implemented based on the characteristics of storage engine.|
| E | |
| Event Notify | The machanism of synchronizing heartbeat information to all nodes is called an event notify. |
| Explicit Transactions| Explicit Transaction has the beginning, ending and rollback of transactions with the command Begin Transaction, Commit Transaction and Rollback Transaction. |
@@ -22,17 +22,16 @@ It's helpful to understand a few terms before reading our architecture documenta
|I| |
| Implicit Transactions| Implicit Transaction is the auto commit. There is no beginning or ending of the transaction. |
| M | |
- | MatrixCube | MatrixCube is a framework for building distributed systems, which offers guarantees about reliability, consistency, and scalability. It is designed to facilitate distributed, stateful application building to allow developers only need to focus on the business logic on a single node. |
| P | |
- | Prophet | Prophet is a scheduling module in MatrixCube. It takes charge of Auto-Rebalance, which keeps the system storage level and read/write throughput level balanced across Stores. The initial 3 Stores of a MatrixCube cluster are all Prophet Nodes. |
+ | Prophet | Prophet is a scheduling module<!-- in MatrixCube-->. It takes charge of Auto-Rebalance, which keeps the system storage level and read/write throughput level balanced across Stores. The initial 3 Stores of a MatrixCube cluster are all Prophet Nodes. |
| Pure Storage | In contrast to Prophet, pure storage is another type of node, which doesn't handle any scheduling job and works as simple storage. |
| R | |
| Replica | To provide reliable service, each shard is stored not only once, it will have several copy stored in different stores. Every copy of a shard is called a Replica. |
| S | |
| Snapshot Isolation (SI) | Snapshot Isolation is a multi-version concurrency control approach that is widely used in practice. MatrixOne supports distributed transaction of snapshot isolation level. |
- | Store | A MatrixCube distributed system consists of several physical servers, our data are stored across these physical server. We call each server inside this cluster a Store. |
+ | Store | A <!--MatrixCube-->distributed system consists of several physical servers, our data are stored across these physical server. We call each server inside this cluster a Store. |
| Shard | In MatrixOne, the data are split into different partitions to store in order to get better scalability. Each partition is called a Shard. In our design, a new created table is initially a Shard. When the size of the table exceeds the Shard size limit, the Shard will split. |
- | Shard Splitting | There is a certain limit to a Shard size. Whenever a Shard exceeds its storage limit, MatrixCube splits a Shard into two Shards and keep each Shard with the same storage level. |
+ | Shard Splitting | There is a certain limit to a Shard size. Whenever a Shard exceeds its storage limit,<!--MatrixCube-->Distributed system splits a Shard into two Shards and keep each Shard with the same storage level. |
| Shard Proxy | The Shard Proxy is a central module to accept all user read/write requests and route requests to corresponding nodes.|
### **Concepts**