sufan721
0df35cfd77
### What problem does this PR solve? Issue Number: None #68346 Related PR: None Problem Summary: The contributing guides linked contributor pages through repository-relative paths such as `./docs/en/community/how-to-contribute/pull-request.md` and `./docs/zh-CN/installing/compilation.md`. The documentation has since moved to the standalone apache/doris-website repository, so the in-tree `docs/` directory now only holds a per-language README shell and `docs/en/` does not exist at all. Every such link in CONTRIBUTING.md and CONTRIBUTING_CN.md therefore resolved to nothing. This replaces all repository-relative documentation links in the two files with their live doris.apache.org URLs, matching the absolute-link style already used by the per-language README files. The affected links are the contributor mailing list, the pull request guide (three occurrences per file), and the compilation document. Note the compilation page slug is `compilation-with-docker`; `.../source-install/compilation/` does not exist. Link targets were verified to return HTTP 200, and a non-existent path on the same host returns 404, so the status codes are meaningful. ### Release note None ### Check List (For Author) - Test: No need to test. No code files have been changed; only documentation links were updated, and all new URLs were verified with curl to return HTTP 200. - Behavior changed: No. - Does this need documentation: No. ### What problem does this PR solve? Issue Number: close #xxx Related PR: #xxx Problem Summary: ### Release note None ### Check List (For Author) - Test <!-- At least one of them must be included. --> - [ ] Regression test - [ ] Unit Test - [ ] Manual test (add detailed scripts or steps below) - [x] No need to test or manual test. Explain why: - [ ] This is a refactor/code format and no logic has been changed. - [ ] Previous test can cover this change. - [x] No code files have been changed. - [ ] Other reason <!-- Add your reason? --> - Behavior changed: - [x] No. - [ ] Yes. <!-- Explain the behavior change --> - Does this need documentation? - [x] No. - [ ] Yes. <!-- Add document PR link here. eg: https://github.com/apache/doris-website/pull/1214 --> ### Check List (For Reviewer who merge this PR) - [ ] Confirm the release note - [ ] Confirm test cases - [ ] Confirm document - [ ] Add branch pick label <!-- Add branch pick label that this PR should merge into -->
5.6 KiB
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.
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 Committer of Apache with Apache mailbox and be included in the list of Apache Committers.
Any questions, you can contact us to get timely answers, including dev mail list or Slack.
Initial contact
For the first time in Doris community, you can:
- Follow Doris GitHub
- Subscribe to our mailing list;
- Join Doris Slack
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, Apache Doris 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) | consists of a query coordinator and a metadata manager | Java |
| Backend daemon (BE) | Responsible for storing data and executing query fragments | C++ |
| Broker | Read HDFS data to Doris | Java |
| Website | Doris Website | Markdown |
| Github 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. If you submit code changes, you can refer to Pull Request.
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, 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.
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) 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.