This is an automated email from the ASF dual-hosted git repository.
morningman pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/incubator-doris.git
The following commit(s) were added to refs/heads/master by this push:
new f781669932 [typo](doc) Fix the broken link in the CONTRIBUTING.md
(#8876)
f781669932 is described below
commit f78166993219ed2c1267829e49ceae205e348587
Author: Mini256 <[email protected]>
AuthorDate: Thu Apr 14 10:04:32 2022 +0800
[typo](doc) Fix the broken link in the CONTRIBUTING.md (#8876)
---
CONTRIBUTING.md | 34 +++++++++++++++++-----------------
CONTRIBUTING_CN.md | 12 ++++++------
2 files changed, 23 insertions(+), 23 deletions(-)
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 669c2d2f91..a37660afa9 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -21,9 +21,9 @@ under the License.
Thank you very much for your interest in the Doris project. We welcome your
suggestions, comments (including criticisms), comments and contributions to the
Doris project.
-Your suggestions, comments and comments on Doris can be made directly through
GitHub's [Issues]
(https://github.com/apache/incubator-doris/issues/new/selection).
+Your suggestions, comments and comments on Doris can be made directly through
GitHub's [Issues](https://github.com/apache/incubator-doris/issues/new/choose).
-There are many ways to participate in and contribute to Doris projects: code
implementation, test writing, process tool improvement, document improvement,
and so on. Any contribution will be welcomed and you will be added to the list
of contributors. Further, with sufficient contributions, you will have the
opportunity to become a Commiter of Apache with Apache mailbox and be included
in the list of [Apache Commiters]
(http://people.apache.org/committer-index.html).
+There are many ways to participate in and contribute to Doris projects: code
implementation, test writing, process tool improvement, document improvement,
and so on. Any contribution will be welcomed and you will be added to the list
of contributors. Further, with sufficient contributions, you will have the
opportunity to become a Commiter of Apache with Apache mailbox and be included
in the list of [Apache
Commiters](http://people.apache.org/committer-index.html).
Any questions, you can contact us to get timely answers, including dev mail
list or Slack.
@@ -32,23 +32,23 @@ Any questions, you can contact us to get timely answers,
including dev mail list
For the first time in Doris community, you can:
* Follow [Doris Github](https://github.com/apache/incubator-doris)
-* Subscribe to our [mailing list] (./subscribe-mail-list.md);
+* Subscribe to our [mailing list](./docs/en/community/subscribe-mail-list.md);
* Join Doris
[Slack](https://join.slack.com/t/apachedoriscommunity/shared_invite/zt-11jb8gesh-7IukzSrdea6mqoG0HB4gZg)
Learn the development trends of Doris project in time and give your opinions
on the topics you are concerned about.
## Doris's code and documentation
-As you can see from [GitHub] (https://github.com/apache/incubator-doris),
Apache Doris (incubating) code base mainly consists of three parts: Frontend
(FE), Backend (BE) and Broker (to support file reading on external storage
systems such as HDFS). Documents are mainly the wiki on Doris website and
GitHub, as well as the online help manual when running Doris. Details of these
components can be found in the following table:
+As you can see from [GitHub](https://github.com/apache/incubator-doris),
Apache Doris (incubating) code base mainly consists of three parts: Frontend
(FE), Backend (BE) and Broker (to support file reading on external storage
systems such as HDFS). Documents are mainly the wiki on Doris website and
GitHub, as well as the online help manual when running Doris. Details of these
components can be found in the following table:
-| Component Name | Component Description | Related Language|
-|--------|----------------------------|----------|
-| [Frontend daemon (FE)] (https://github.com/apache/incubator-doris) |
consists of a query coordinator and a metadata manager | Java|
-| [Backend daemon (BE)] (https://github.com/apache/incubator-doris) |
Responsible for storing data and executing query fragments | C++|
-| [Broker] (https://github.com/apache/incubator-doris) | Read HDFS data to
Doris | Java|
-| [Website](https://github.com/apache/incubator-doris-website) | Doris Website
| Markdown |
-+ [Github Wiki] (https://github.com/apache/incubator-doris/wiki); Doris Github
Wiki; Markdown_;
-| Doris Runtime Help Document | Online Help Manual at Doris Runtime | Markdown|
+| Component Name |
Component Description | Related Language |
+|-------------------------------------------------------------------|------------------------------------------------------------|------------------|
+| [Frontend daemon (FE)](https://github.com/apache/incubator-doris) | consists
of a query coordinator and a metadata manager | Java |
+| [Backend daemon (BE)](https://github.com/apache/incubator-doris) |
Responsible for storing data and executing query fragments | C++ |
+| [Broker](https://github.com/apache/incubator-doris) | Read
HDFS data to Doris | Java |
+| [Website](https://github.com/apache/incubator-doris-website) | Doris
Website | Markdown |
+| [Github Wiki](https://github.com/apache/incubator-doris/wiki) | Doris
Github Wiki | Markdown |
+| Doris Runtime Help Document | Online
Help Manual at Doris Runtime | Markdown |
## Improving documentation
@@ -58,18 +58,18 @@ Browse the document, you can deepen your understanding of
Doris, can also help y
If you are interested in improving the quality of documents, whether it is
revising the address of a page, correcting a link, and writing a better
introductory document, we are very welcome!
-Most of our documents are written in markdown format, and you can modify and
submit document changes directly through `docs/` in [GitHub]
(https://github.com/apache/incubator-doris). If you submit code changes, you
can refer to [Pull Request] (./pull-request.md).
+Most of our documents are written in markdown format, and you can modify and
submit document changes directly through `docs/` in
[GitHub](https://github.com/apache/incubator-doris). If you submit code
changes, you can refer to [Pull
Request](./docs/en/community/how-to-contribute/pull-request.md).
## If a Bug or problem is found
-If a Bug or problem is found, you can directly raise a new Issue through
GitHub's [Issues]
(https://github.com/apache/incubator-doris/issues/new/select), and we will have
someone deal with it regularly.
+If a Bug or problem is found, you can directly raise a new Issue through
GitHub's [Issues](https://github.com/apache/incubator-doris/issues/new/choose),
and we will have someone deal with it regularly.
-You can also fix it yourself by reading the analysis code (of course, it's
better to talk to us before that, maybe someone has fixed the same problem) and
submit a [Pull Request] (./pull-request.md).
+You can also fix it yourself by reading the analysis code (of course, it's
better to talk to us before that, maybe someone has fixed the same problem) and
submit a [Pull Request](./docs/en/community/how-to-contribute/pull-request.md).
## Modify the code and submit PR (Pull Request)
-You can download the code, compile and install it, deploy and run it for a try
(refer to the [compilation document] (./installing/compilation.md)) to see if
it works as you expected. If you have problems, you can contact us directly,
ask questions or fix them by reading and analyzing the source code.
+You can download the code, compile and install it, deploy and run it for a try
(refer to the [compilation document](./docs/en/installing/compilation.md)) to
see if it works as you expected. If you have problems, you can contact us
directly, ask questions or fix them by reading and analyzing the source code.
Whether it's fixing Bugs or adding Features, we're all very welcome. If you
want to submit code to Doris, you need to create a new branch for your
submitted code from the fork code library on GitHub to your project space, add
the source project upstream, and submit PR.
-About how to submit a PR refer to [Pull Request] (./pull-request.md).
+About how to submit a PR refer to [Pull
Request](./docs/en/community/how-to-contribute/pull-request.md).
diff --git a/CONTRIBUTING_CN.md b/CONTRIBUTING_CN.md
index 7de688f06e..951c4da735 100644
--- a/CONTRIBUTING_CN.md
+++ b/CONTRIBUTING_CN.md
@@ -32,14 +32,14 @@ under the License.
初次来到 Doris 社区，您可以：
* 关注 Doris [Github 代码库](https://github.com/apache/incubator-doris)
-* 订阅我们的 [邮件列表](./subscribe-mail-list.md)；
+* 订阅我们的 [邮件列表](./docs/zh-CN/community/subscribe-mail-list.md)；
* 加入 Doris 的
[Slack](https://join.slack.com/t/apachedoriscommunity/shared_invite/zt-11jb8gesh-7IukzSrdea6mqoG0HB4gZg)
通过以上方式及时了解 Doris 项目的开发动态并为您关注的话题发表意见。
## Doris 的代码和文档
-正如您在 [GitHub] (https://github.com/apache/incubator-doris) 上看到的，Apache Doris
(incubating) 的代码库主要包括三部分：Frontend (FE), Backend (BE) 和 Broker (为了支持 HDFS
等外部存储系统上的文件读取)。文档主要是 Doris 网站和 GitHub 上的 wiki，还有运行 Doris
的时候的在线帮助手册。这些组件的详细情况参见下表：
+正如您在 [GitHub](https://github.com/apache/incubator-doris) 上看到的，Apache Doris
(incubating) 的代码库主要包括三部分：Frontend (FE), Backend (BE) 和 Broker (为了支持 HDFS
等外部存储系统上的文件读取)。文档主要是 Doris 网站和 GitHub 上的 wiki，还有运行 Doris
的时候的在线帮助手册。这些组件的详细情况参见下表：
| 组件名称 | 组件描述 | 相关语言 |
|--------|----------------------------|----------|
@@ -58,17 +58,17 @@ under the License.
如果您对改进文档的质量感兴趣，不论是修订一个页面的地址、更正一个链接、以及写一篇更优秀的入门文档，我们都非常欢迎！
-我们的文档大多数是使用 markdown 格式编写的，您可以直接通过在 [GitHub]
(https://github.com/apache/incubator-doris) 中的 `docs/` 中修改并提交文档变更。如果提交代码变更，可以参阅
[Pull Request](./pull-request.md)。
+我们的文档大多数是使用 markdown 格式编写的，您可以直接通过在
[GitHub](https://github.com/apache/incubator-doris) 中的 `docs/`
中修改并提交文档变更。如果提交代码变更，可以参阅 [Pull
Request](./docs/zh-CN/community/how-to-contribute/pull-request.md)。
## 如果发现了一个 Bug 或问题
如果发现了一个 Bug 或问题，您可以直接通过 GitHub 的
[Issues](https://github.com/apache/incubator-doris/issues/new/choose) 提一个新的
Issue，我们会有人定期处理。
-您也可以通过阅读分析代码自己修复（当然在这之前最好能和我们交流下，或许已经有人在修复同样的问题了），然后提交一个 [Pull
Request](./pull-request.md)。
+您也可以通过阅读分析代码自己修复（当然在这之前最好能和我们交流下，或许已经有人在修复同样的问题了），然后提交一个 [Pull
Request](./docs/zh-CN/community/how-to-contribute/pull-request.md)。
## 修改代码和提交PR（Pull Request）
-您可以下载代码，编译安装，部署运行试一试（可以参考[编译文档](../installing/compilation.md)），看看是否与您预想的一样工作。如果有问题，您可以直接联系我们，提
Issue 或者通过阅读和分析源代码自己修复。
+您可以下载代码，编译安装，部署运行试一试（可以参考
[编译文档](./docs/zh-CN/installing/compilation.md)），看看是否与您预想的一样工作。如果有问题，您可以直接联系我们，提
Issue 或者通过阅读和分析源代码自己修复。
无论是修复 Bug 还是增加 Feature，我们都非常欢迎。如果您希望给 Doris 提交代码，您需要从 GitHub 上 fork
代码库至您的项目空间下，为您提交的代码创建一个新的分支，添加源项目为upstream，并提交PR。
-提交PR的方式可以参考文档 [Pull Request](./pull-request.md)。
+提交PR的方式可以参考文档 [Pull
Request](./docs/zh-CN/community/how-to-contribute/pull-request.md)。
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
