You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@doris.apache.org by mo...@apache.org on 2020/04/29 13:56:46 UTC
[incubator-doris] branch master updated: [Doc] Fix linked file not
found (#3434)
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 beb5b29 [Doc] Fix linked file not found (#3434)
beb5b29 is described below
commit beb5b29f66837826130443278ea693b43357539a
Author: yangzhg <78...@qq.com>
AuthorDate: Wed Apr 29 21:56:34 2020 +0800
[Doc] Fix linked file not found (#3434)
the source file of soft link CONTRIBUTING.md is changed, make it to a regular file
---
CONTRIBUTING.md | 77 +++++++++++++++++++++++++++++++++++++++++++++++++++++-
CONTRIBUTING_CN.md | 76 ++++++++++++++++++++++++++++++++++++++++++++++++++++-
2 files changed, 151 insertions(+), 2 deletions(-)
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
deleted file mode 120000
index b3aec0a..0000000
--- a/CONTRIBUTING.md
+++ /dev/null
@@ -1 +0,0 @@
-docs/documentation/en/community/how-to-contribute_EN.md
\ No newline at end of file
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
new file mode 100644
index 0000000..069c0c9
--- /dev/null
+++ b/CONTRIBUTING.md
@@ -0,0 +1,76 @@
+<!--
+Licensed to the Apache Software Foundation (ASF) under one
+or more contributor license agreements. See the NOTICE file
+distributed with this work for additional information
+regarding copyright ownership. The ASF licenses this file
+to you under the Apache License, Version 2.0 (the
+"License"); you may not use this file except in compliance
+with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing,
+software distributed under the License is distributed on an
+"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, either express or implied. See the License for the
+specific language governing permissions and limitations
+under the License.
+-->
+
+# Contribute to Doris
+
+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).
+
+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 Aapche 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 Wechat, Gitter (GitHub instant messaging tool), e-mail and so on.
+
+## Initial contact
+
+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);
+* Join Doris Wechat Group (add micro-signal: morningman-cmy, note: join Doris Group) and ask questions at any time.
+* Enter Doris's [Gitter] (./gitter.md) chat room;
+
+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:
+
+| 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
+
+Documentation is the most important way for you to understand Apache Doris, and it's where we need help most!
+
+Browse the document, you can deepen your understanding of Doris, can also help you understand Doris's function and technical details, if you find that the document has problems, please contact us in time;
+
+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).
+
+## 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.
+
+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).
+
+## 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.
+
+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).
diff --git a/CONTRIBUTING_CN.md b/CONTRIBUTING_CN.md
deleted file mode 120000
index 2807700..0000000
--- a/CONTRIBUTING_CN.md
+++ /dev/null
@@ -1 +0,0 @@
-docs/documentation/cn/community/how-to-contribute.md
\ No newline at end of file
diff --git a/CONTRIBUTING_CN.md b/CONTRIBUTING_CN.md
new file mode 100644
index 0000000..040810b
--- /dev/null
+++ b/CONTRIBUTING_CN.md
@@ -0,0 +1,75 @@
+<!--
+Licensed to the Apache Software Foundation (ASF) under one
+or more contributor license agreements. See the NOTICE file
+distributed with this work for additional information
+regarding copyright ownership. The ASF licenses this file
+to you under the Apache License, Version 2.0 (the
+"License"); you may not use this file except in compliance
+with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing,
+software distributed under the License is distributed on an
+"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, either express or implied. See the License for the
+specific language governing permissions and limitations
+under the License.
+-->
+
+# 为 Doris 做贡献
+
+非常感谢您对 Doris 项目感兴趣，我们非常欢迎您对 Doris 项目的各种建议、意见（包括批评）、评论和贡献。
+
+您对 Doris 的各种建议、意见、评论可以直接通过 GitHub 的 [Issues](https://github.com/apache/incubator-doris/issues/new/choose) 提出。
+
+参与 Doris 项目并为其作出贡献的方法有很多：代码实现、测试编写、流程工具改进、文档完善等等。任何贡献我们都会非常欢迎，并将您加入贡献者列表，进一步，有了足够的贡献后，您还可以有机会成为 Aapche 的 Commiter，拥有 Apache 邮箱，并被收录到 [Apache Commiter 列表中](http://people.apache.org/committer-index.html)。
+
+任何问题，您都可以联系我们得到及时解答，联系方式包括微信、Gitter（GitHub提供的即时聊天工具）、邮件等等。
+
+## 初次接触
+
+初次来到 Doris 社区，您可以：
+
+* 关注 Doris [Github 代码库](https://github.com/apache/incubator-doris)
+* 订阅我们的 [邮件列表](./subscribe-mail-list.md)；
+* 加入 Doris 微信群(加微信号：morningman-cmy, 备注：加入Doris群) 随时提问；
+* 进入 Doris 的 [Gitter](./gitter.md) 聊天室；
+
+通过以上方式及时了解 Doris 项目的开发动态并为您关注的话题发表意见。
+
+## Doris 的代码和文档
+
+正如您在 [GitHub] (https://github.com/apache/incubator-doris) 上看到的，Apache Doris (incubating) 的代码库主要包括三部分：Frontend (FE), Backend (BE) 和 Broker (为了支持 HDFS 等外部存储系统上的文件读取)。文档主要是 Doris 网站和 GitHub 上的 wiki，还有运行 Doris 的时候的在线帮助手册。这些组件的详细情况参见下表：
+
+| 组件名称 | 组件描述 | 相关语言 |
+|--------|----------------------------|----------|
+| [Frontend daemon (FE)](https://github.com/apache/incubator-doris)| 由“查询协调器”和“元数据管理器”组成 | Java|
+| [Backend daemon (BE)](https://github.com/apache/incubator-doris) | 负责存储数据和执行查询片段 | C++|
+| [Broker](https://github.com/apache/incubator-doris) | 读取 HDFS 数据到 Doris | Java |
+| [Website](https://github.com/apache/incubator-doris-website) | Doris 网站 | Markdown |
+| [GitHub Wiki](https://github.com/apache/incubator-doris/wiki) | Doris GitHub Wiki | Markdown |
+| Doris 运行时 help 文档 | 运行 Doris 的时候的在线帮助手册 | Markdown |
+
+## 改进文档
+
+文档是您了解 Apache Doris 的最主要的方式，也是我们最需要帮助的地方！
+
+浏览文档，可以加深您对 Doris 的了解，也可以帮助您理解 Doris 的功能和技术细节，如果您发现文档有问题，请及时联系我们；
+
+如果您对改进文档的质量感兴趣，不论是修订一个页面的地址、更正一个链接、以及写一篇更优秀的入门文档，我们都非常欢迎！
+
+我们的文档大多数是使用 markdown 格式编写的，您可以直接通过在 [GitHub] (https://github.com/apache/incubator-doris) 中的 `docs/` 中修改并提交文档变更。如果提交代码变更，可以参阅 [Pull Request](./pull-request.md)。
+
+## 如果发现了一个 Bug 或问题
+
+如果发现了一个 Bug 或问题，您可以直接通过 GitHub 的 [Issues](https://github.com/apache/incubator-doris/issues/new/choose) 提一个新的 Issue，我们会有人定期处理。
+
+您也可以通过阅读分析代码自己修复（当然在这之前最好能和我们交流下，或许已经有人在修复同样的问题了），然后提交一个 [Pull Request](./pull-request.md)。
+
+## 修改代码和提交PR（Pull Request）
+
+您可以下载代码，编译安装，部署运行试一试（可以参考[编译文档](../installing/compilation.md)），看看是否与您预想的一样工作。如果有问题，您可以直接联系我们，提 Issue 或者通过阅读和分析源代码自己修复。
+
+无论是修复 Bug 还是增加 Feature，我们都非常欢迎。如果您希望给 Doris 提交代码，您需要从 GitHub 上 fork 代码库至您的项目空间下，为您提交的代码创建一个新的分支，添加源项目为upstream，并提交PR。
+提交PR的方式可以参考文档 [Pull Request](./pull-request.md)。
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@doris.apache.org
For additional commands, e-mail: commits-help@doris.apache.org