From 185de4dd434aed99e8c5a48a76f452e63ef9f510 Mon Sep 17 00:00:00 2001 From: Yankee Date: Mon, 20 Jun 2022 09:24:49 +0800 Subject: [PATCH] [docs]update develop document (#10242) --- .../developer-guide/be-vscode-dev.md | 46 +++++++++---------- .../developer-guide/benchmark-tool.md | 4 +- .../developer-guide/cpp-diagnostic-code.md | 3 +- .../developer-guide/cpp-format-code.md | 2 +- .../developer/developer-guide/docker-dev.md | 6 +-- .../developer-guide/fe-vscode-dev.md | 4 +- .../developer-guide/how-to-share-blogs.md | 4 +- .../developer-guide/be-vscode-dev.md | 46 +++++++++---------- .../developer-guide/benchmark-tool.md | 2 +- .../developer-guide/cpp-diagnostic-code.md | 3 +- .../developer-guide/cpp-format-code.md | 2 +- .../developer/developer-guide/docker-dev.md | 6 +-- .../developer-guide/fe-vscode-dev.md | 2 +- .../developer-guide/how-to-share-blogs.md | 2 +- 14 files changed, 67 insertions(+), 65 deletions(-) diff --git a/docs/en/developer/developer-guide/be-vscode-dev.md b/docs/en/developer/developer-guide/be-vscode-dev.md index 75172ed279..89cb3b5189 100644 --- a/docs/en/developer/developer-guide/be-vscode-dev.md +++ b/docs/en/developer/developer-guide/be-vscode-dev.md @@ -32,7 +32,7 @@ under the License. 1. Download the doris source code - URL：[apache/incubator-doris: Apache Doris (Incubating) (github.com)](https://github.com/apache/incubator-doris) + URL：[apache/doris: Apache Doris (github.com)](https://github.com/apache/doris) 2. Install GCC 8.3.1+, Oracle JDK 1.8+, Python 2.7+, confirm that the gcc, java, python commands point to the correct version, and set the JAVA_HOME environment variable @@ -58,20 +58,20 @@ The following steps are carried out in the /home/workspace directory 1. dowload source ``` -git clone https://github.com/apache/incubator-doris.git +git clone https://github.com/apache/doris.git ``` 2. Compile third-party dependency packages ``` - cd /home/workspace/incubator-doris/thirdparty + cd /home/workspace/doris/thirdparty ./build-thirdparty.sh ``` 3. Compile doris product code ``` -cd /home/workspace/incubator-doris +cd /home/workspace/doris ./build.sh ``` @@ -87,21 +87,21 @@ Note: This compilation has the following instructions: ./build.sh --be --fe --clean#Delete and compile be fe at the same time ``` -If nothing happens, the compilation should be successful, and the final deployment file will be output to the /home/zhangfeng/incubator-doris/output/ directory. If you still encounter other problems, you can refer to the doris installation document http://doris.apache.org. +If nothing happens, the compilation should be successful, and the final deployment file will be output to the /home/workspace/doris/output/ directory. If you still encounter other problems, you can refer to the doris installation document http://doris.apache.org. ## Deployment and debugging 1. Authorize be compilation result files ``` -chmod /home/workspace/incubator-doris/output/be/lib/palo_be +chmod /home/workspace/doris/output/be/lib/palo_be ``` -Note: /home/workspace/incubator-doris/output/be/lib/palo_be is the executable file of be. +Note: /home/workspace/doris/output/be/lib/palo_be is the executable file of be. 2. Create a data storage directory -By viewing /home/workspace/incubator-doris/output/be/conf/be.conf +By viewing /home/workspace/doris/output/be/conf/be.conf ``` # INFO, WARNING, ERROR, FATAL @@ -132,7 +132,7 @@ Need to create this folder, this is where the be data is stored mkdir -p /soft/be/storage ``` -3. Open vscode, and open the directory where the be source code is located. In this case, open the directory as **/home/workspace/incubator-doris/**，For details on how to vscode, refer to the online tutorial +3. Open vscode, and open the directory where the be source code is located. In this case, open the directory as **/home/workspace/doris/**，For details on how to vscode, refer to the online tutorial 4. Install the vscode ms c++ debugging plug-in, the plug-in identified by the red box in the figure below @@ -148,14 +148,14 @@ mkdir -p /soft/be/storage "name": "(gdb) Launch", "type": "cppdbg", "request": "launch", - "program": "/home/workspace/incubator-doris/output/be/lib/palo_be", + "program": "/home/workspace/doris/output/be/lib/palo_be", "args": [], "stopAtEntry": false, - "cwd": "/home/workspace/incubator-doris/", - "environment": [{"name":"PALO_HOME","value":"/home/workspace/incubator-doris/output/be/"}, - {"name":"UDF_RUNTIME_DIR","value":"/home/workspace/incubator-doris/output/be/lib/udf-runtime"}, - {"name":"LOG_DIR","value":"/home/workspace/incubator-doris/output/be/log"}, - {"name":"PID_DIR","value":"/home/workspace/incubator-doris/output/be/bin"} + "cwd": "/home/workspace/doris/", + "environment": [{"name":"PALO_HOME","value":"/home/workspace/doris/output/be/"}, + {"name":"UDF_RUNTIME_DIR","value":"/home/workspace/doris/output/be/lib/udf-runtime"}, + {"name":"LOG_DIR","value":"/home/workspace/doris/output/be/log"}, + {"name":"PID_DIR","value":"/home/workspace/doris/output/be/bin"} ], "externalConsole": true, "MIMode": "gdb", @@ -183,7 +183,7 @@ Among them, environment defines several environment variables DORIS_HOME UDF_RUN "name": "(gdb) Launch", "type": "cppdbg", "request": "attach", - "program": "/home/workspace/incubator-doris/output/lib/palo_be", + "program": "/home/workspace/doris/output/lib/palo_be", "processId":, "MIMode": "gdb", "internalConsoleOptions":"openOnSessionStart", @@ -221,7 +221,7 @@ An example of a complete launch.json is as follows: "name": "(gdb) Attach", "type": "cppdbg", "request": "attach", - "program": "/home/workspace/incubator-doris/output/be/lib/palo_be", + "program": "/home/workspace/doris/output/be/lib/palo_be", "processId": 17016, "MIMode": "gdb", "setupCommands": [ @@ -236,26 +236,26 @@ An example of a complete launch.json is as follows: "name": "(gdb) Launch", "type": "cppdbg", "request": "launch", - "program": "/home/workspace/incubator-doris/output/be/lib/palo_be", + "program": "/home/workspace/doris/output/be/lib/palo_be", "args": [], "stopAtEntry": false, - "cwd": "/home/workspace/incubator-doris/output/be", + "cwd": "/home/workspace/doris/output/be", "environment": [ { "name": "DORIS_HOME", - "value": "/home/workspace/incubator-doris/output/be" + "value": "/home/workspace/doris/output/be" }, { "name": "UDF_RUNTIME_DIR", - "value": "/home/workspace/incubator-doris/output/be/lib/udf-runtime" + "value": "/home/workspace/doris/output/be/lib/udf-runtime" }, { "name": "LOG_DIR", - "value": "/home/workspace/incubator-doris/output/be/log" + "value": "/home/workspace/doris/output/be/log" }, { "name": "PID_DIR", - "value": "/home/workspace/incubator-doris/output/be/bin" + "value": "/home/workspace/doris/output/be/bin" } ], "externalConsole": false, diff --git a/docs/en/developer/developer-guide/benchmark-tool.md b/docs/en/developer/developer-guide/benchmark-tool.md index 0c903051d1..21cacc9656 100644 --- a/docs/en/developer/developer-guide/benchmark-tool.md +++ b/docs/en/developer/developer-guide/benchmark-tool.md @@ -1,7 +1,7 @@ --- { "title": "Doris BE Storage Layer Benchmark Tool", - "language": "zh-CN" + "language": "en" } --- @@ -33,7 +33,7 @@ It can be used to test the performance of some parts of the BE storage layer (fo ## Compilation -1. To ensure that the environment has been able to successfully compile the Doris ontology, you can refer to [Installation and deployment](../install/source-install/compilation.md)。 +1. To ensure that the environment has been able to successfully compile the Doris ontology, you can refer to [Installation and deployment](../../docs/install/source-install/compilation.md)。 2. Execute`run-be-ut.sh` diff --git a/docs/en/developer/developer-guide/cpp-diagnostic-code.md b/docs/en/developer/developer-guide/cpp-diagnostic-code.md index d50ff44bf8..e0051209f2 100644 --- a/docs/en/developer/developer-guide/cpp-diagnostic-code.md +++ b/docs/en/developer/developer-guide/cpp-diagnostic-code.md @@ -26,7 +26,8 @@ under the License. # C++ Code Diagnostic -Doris support to use [Clangd](https://clangd.llvm.org/) and [Clang-Tidy](https://clang.llvm.org/extra/clang-tidy/) to diagnostic code. Clangd and Clang-Tidy already has in [LDB-toolchain](../install/source-install/compilation-with-ldb-toolchain.md)，also can install by self. +Doris support to use [Clangd](https://clangd.llvm.org/) and [Clang-Tidy](https://clang.llvm.org/extra/clang-tidy/) +to diagnostic code. Clangd and Clang-Tidy already has in [LDB-toolchain](../../docs/install/source-install/compilation-with-ldb-toolchain.md)，also can install by self. ### Clang-Tidy Clang-Tidy can do some diagnostic cofig, config file `.clang-tidy` is in Doris root path. Compared with vscode-cpptools, clangd can provide more powerful and accurate code jumping for vscode, and integrates the analysis and quick-fix functions of clang-tidy. diff --git a/docs/en/developer/developer-guide/cpp-format-code.md b/docs/en/developer/developer-guide/cpp-format-code.md index 173ff0cac5..4670a9bdaf 100644 --- a/docs/en/developer/developer-guide/cpp-format-code.md +++ b/docs/en/developer/developer-guide/cpp-format-code.md @@ -66,7 +66,7 @@ The version of clang-format installed by centos yum is too old and supports too LDB toolchain: -If you are using [LDB toolchain](http://doris.incubator.apache.org/install/source-install/compilation-with-ldb-toolchain.html), +If you are using [LDB toolchain](../../docs/install/source-install/compilation-with-ldb-toolchain.md), the latest version (>= v0.11) of [LDB toolchain](https://github.com/amosbird/ldb_toolchain_gen/releases) has already included clang-format with 13.0.1 version. ### clang-format plugin diff --git a/docs/en/developer/developer-guide/docker-dev.md b/docs/en/developer/developer-guide/docker-dev.md index 938550ccb1..8b164e856c 100644 --- a/docs/en/developer/developer-guide/docker-dev.md +++ b/docs/en/developer/developer-guide/docker-dev.md @@ -29,8 +29,8 @@ under the License. ## Related detailed document navigation -- [Developing mirror compilation using Docker](../install/source-install/compilation.md#developing-mirror-compilation-using-docker-recommended) -- [Deploying Doris](../install/install-deploy.md#cluster-deployment) +- [Developing mirror compilation using Docker](../../docs/install/source-install/compilation.md#developing-mirror-compilation-using-docker-recommended) +- [Deploying Doris](../../docs/install/install-deploy.md#cluster-deployment) - [VSCode Be Development Debugging](./be-vscode-dev.md) ## Environment preparation @@ -90,7 +90,7 @@ docker build -t doris . run image -note! [problems with mounting](../install/source-install/compilation.md) +note! [problems with mounting](../../docs/install/source-install/compilation.md) > See the link above: It is recommended to run the image by mounting the local Doris source code directory as a volume ..... diff --git a/docs/en/developer/developer-guide/fe-vscode-dev.md b/docs/en/developer/developer-guide/fe-vscode-dev.md index 605beb23e1..fe8840e08c 100644 --- a/docs/en/developer/developer-guide/fe-vscode-dev.md +++ b/docs/en/developer/developer-guide/fe-vscode-dev.md @@ -1,7 +1,7 @@ --- { "title": "FE development and debugging environment - Visual Studio Code (VSCode)", - "language": "zh-CN" + "language": "en" } --- @@ -72,7 +72,7 @@ example: ## Build Other articles have already explained: -* [Build with LDB toolchain ](../install/source-install/compilation-with-ldb-toolchain.md) +* [Build with LDB toolchain ](../../docs/install/source-install/compilation-with-ldb-toolchain.md) * ...... In order to debug, you need to add debugging parameters when fe starts, such as `-agentlib:jdwp=transport=dt_socket,server=y,suspend=n,address=5005` . diff --git a/docs/en/developer/developer-guide/how-to-share-blogs.md b/docs/en/developer/developer-guide/how-to-share-blogs.md index 15bf740a0c..56ed87e072 100644 --- a/docs/en/developer/developer-guide/how-to-share-blogs.md +++ b/docs/en/developer/developer-guide/how-to-share-blogs.md @@ -1,7 +1,7 @@ --- { "title": "How to share blogs", - "language": "zh-CN" + "language": "en" } --- @@ -36,4 +36,4 @@ Articles include, but are not limited to. * How Doris works * Doris business scenarios in practice -For details, please go to: https://github.com/apache/incubator-doris-website [README](https://github.com/apache/incubator-doris-website) +For details, please go to: https://github.com/apache/doris-website [README](https://github.com/apache/doris-website) diff --git a/docs/zh-CN/developer/developer-guide/be-vscode-dev.md b/docs/zh-CN/developer/developer-guide/be-vscode-dev.md index 642e81a9dc..5a6430dc7f 100644 --- a/docs/zh-CN/developer/developer-guide/be-vscode-dev.md +++ b/docs/zh-CN/developer/developer-guide/be-vscode-dev.md @@ -33,7 +33,7 @@ under the License. 1. 下载 doris 源代码 - 下载地址为：[apache/incubator-doris: Apache Doris (Incubating) (github.com)](https://github.com/apache/incubator-doris) + 下载地址为：[apache/doris: Apache Doris (github.com)](https://github.com/apache/doris) 2. 安装 GCC 8.3.1+，Oracle JDK 1.8+，Python 2.7+，确认 gcc, java, python 命令指向正确版本, 设置 JAVA_HOME 环境变量 @@ -60,20 +60,20 @@ sudo apt install -y openssl-devel 1. 下载源码 ``` -git clone https://github.com/apache/incubator-doris.git +git clone https://github.com/apache/doris.git ``` 2. 编译第三方依赖包 ``` - cd /home/workspace/incubator-doris/thirdparty + cd /home/workspace/doris/thirdparty ./build-thirdparty.sh ``` 3. 编译doris产品代码 ``` -cd /home/workspace/incubator-doris +cd /home/workspace/doris ./build.sh ``` @@ -90,21 +90,21 @@ cd /home/workspace/incubator-doris ./build.sh --be --fe --clean#删除并同时编译be fe ``` -如果不出意外，应该会编译成功，最终的部署文件将产出到 /home/workspace/incubator-doris/output/ 目录下。如果还遇到其他问题，可以参照 doris 的安装文档 http://doris.apache.org。 +如果不出意外，应该会编译成功，最终的部署文件将产出到 /home/workspace/doris/output/ 目录下。如果还遇到其他问题，可以参照 doris 的安装文档 http://doris.apache.org。 ## 部署调试 1. 给be编译结果文件授权 ``` -chmod /home/workspace/incubator-doris/output/be/lib/palo_be +chmod /home/workspace/doris/output/be/lib/palo_be ``` -注意： /home/workspace/incubator-doris/output/be/lib/palo_be为be的执行文件。 +注意： /home/workspace/doris/output/be/lib/palo_be为be的执行文件。 2. 创建数据存放目录 -通过查看/home/workspace/incubator-doris/output/be/conf/be.conf +通过查看/home/workspace/doris/output/be/conf/be.conf ``` # INFO, WARNING, ERROR, FATAL @@ -135,7 +135,7 @@ storage_root_path = /soft/be/storage mkdir -p /soft/be/storage ``` -3. 打开 vscode，并打开 be 源码所在目录，在本案例中打开目录为 **/home/workspace/incubator-doris/** +3. 打开 vscode，并打开 be 源码所在目录，在本案例中打开目录为 **/home/workspace/doris/** 4. 安装 vscode ms c++ 调试插件 @@ -151,14 +151,14 @@ mkdir -p /soft/be/storage "name": "(gdb) Launch", "type": "cppdbg", "request": "launch", - "program": "/home/workspace/incubator-doris/output/be/lib/palo_be", + "program": "/home/workspace/doris/output/be/lib/palo_be", "args": [], "stopAtEntry": false, - "cwd": "/home/workspace/incubator-doris/", - "environment": [{"name":"PALO_HOME","value":"/home/workspace/incubator-doris/output/be/"}, - {"name":"UDF_RUNTIME_DIR","value":"/home/workspace/incubator-doris/output/be/lib/udf-runtime"}, - {"name":"LOG_DIR","value":"/home/workspace/incubator-doris/output/be/log"}, - {"name":"PID_DIR","value":"/home/workspace/incubator-doris/output/be/bin"} + "cwd": "/home/workspace/doris/", + "environment": [{"name":"PALO_HOME","value":"/home/workspace/doris/output/be/"}, + {"name":"UDF_RUNTIME_DIR","value":"/home/workspace/doris/output/be/lib/udf-runtime"}, + {"name":"LOG_DIR","value":"/home/workspace/doris/output/be/log"}, + {"name":"PID_DIR","value":"/home/workspace/doris/output/be/bin"} ], "externalConsole": true, "MIMode": "gdb", @@ -186,7 +186,7 @@ mkdir -p /soft/be/storage "name": "(gdb) Launch", "type": "cppdbg", "request": "attach", - "program": "/home/workspace/incubator-doris/output/lib/palo_be", + "program": "/home/workspace/doris/output/lib/palo_be", "processId":, "MIMode": "gdb", "internalConsoleOptions":"openOnSessionStart", @@ -224,7 +224,7 @@ ps -ef | grep palo* "name": "(gdb) Attach", "type": "cppdbg", "request": "attach", - "program": "/home/workspace/incubator-doris/output/be/lib/palo_be", + "program": "/home/workspace/doris/output/be/lib/palo_be", "processId": 17016, "MIMode": "gdb", "setupCommands": [ @@ -239,26 +239,26 @@ ps -ef | grep palo* "name": "(gdb) Launch", "type": "cppdbg", "request": "launch", - "program": "/home/workspace/incubator-doris/output/be/lib/palo_be", + "program": "/home/workspace/doris/output/be/lib/palo_be", "args": [], "stopAtEntry": false, - "cwd": "/home/workspace/incubator-doris/output/be", + "cwd": "/home/workspace/doris/output/be", "environment": [ { "name": "DORIS_HOME", - "value": "/home/workspace/incubator-doris/output/be" + "value": "/home/workspace/doris/output/be" }, { "name": "UDF_RUNTIME_DIR", - "value": "/home/workspace/incubator-doris/output/be/lib/udf-runtime" + "value": "/home/workspace/doris/output/be/lib/udf-runtime" }, { "name": "LOG_DIR", - "value": "/home/workspace/incubator-doris/output/be/log" + "value": "/home/workspace/doris/output/be/log" }, { "name": "PID_DIR", - "value": "/home/workspace/incubator-doris/output/be/bin" + "value": "/home/workspace/doris/output/be/bin" } ], "externalConsole": false, diff --git a/docs/zh-CN/developer/developer-guide/benchmark-tool.md b/docs/zh-CN/developer/developer-guide/benchmark-tool.md index 5debb15278..d6126c2920 100644 --- a/docs/zh-CN/developer/developer-guide/benchmark-tool.md +++ b/docs/zh-CN/developer/developer-guide/benchmark-tool.md @@ -33,7 +33,7 @@ under the License. ## 编译 -1. 确保环境已经能顺利编译Doris本体,可以参考[编译与部署](../install/source-install/compilation.md)。 +1. 确保环境已经能顺利编译Doris本体,可以参考[编译与部署](../../docs/install/source-install/compilation.md)。 2. 运行目录下的`run-be-ut.sh` diff --git a/docs/zh-CN/developer/developer-guide/cpp-diagnostic-code.md b/docs/zh-CN/developer/developer-guide/cpp-diagnostic-code.md index 62e365c6a0..66e8d40dd4 100644 --- a/docs/zh-CN/developer/developer-guide/cpp-diagnostic-code.md +++ b/docs/zh-CN/developer/developer-guide/cpp-diagnostic-code.md @@ -26,7 +26,8 @@ under the License. # C++ 代码分析 -Doris支持使用[Clangd](https://clangd.llvm.org/)和[Clang-Tidy](https://clang.llvm.org/extra/clang-tidy/)进行代码静态分析。Clangd和Clang-Tidy在[LDB-toolchain](../install/source-install/compilation-with-ldb-toolchain.md)中已经内置，另外也可以自己安装或者编译。 +Doris支持使用[Clangd](https://clangd.llvm.org/)和[Clang-Tidy](https://clang.llvm.org/extra/clang-tidy/)进行代码静态分析。Clangd和Clang-Tidy在[LDB-toolchain](../../docs/install/source-install/compilation-with-ldb-toolchain.md) +中已经内置，另外也可以自己安装或者编译。 ### Clang-Tidy Clang-Tidy中可以做一些代码分析的配置,配置文件`.clang-tidy`在Doris根目录下。 diff --git a/docs/zh-CN/developer/developer-guide/cpp-format-code.md b/docs/zh-CN/developer/developer-guide/cpp-format-code.md index 522589a8d6..77a19b0148 100644 --- a/docs/zh-CN/developer/developer-guide/cpp-format-code.md +++ b/docs/zh-CN/developer/developer-guide/cpp-format-code.md @@ -66,7 +66,7 @@ centos yum安装的clang-format版本过老，支持的StyleOption太少，建 LDB toolchain: -如果使用[LDB toolchain](http://doris.incubator.apache.org/zh-CN/install/source-install/compilation-with-ldb-toolchain.html)， +如果使用[LDB toolchain](../../docs/install/source-install/compilation-with-ldb-toolchain.md)， 最新版本的[LDB toolchain](https://github.com/amosbird/ldb_toolchain_gen/releases)（>= v0.11）已经包含了预编译的clang-format 13.0.1的二进制文件。 diff --git a/docs/zh-CN/developer/developer-guide/docker-dev.md b/docs/zh-CN/developer/developer-guide/docker-dev.md index 6a9e3da1c2..f5f90ad84b 100644 --- a/docs/zh-CN/developer/developer-guide/docker-dev.md +++ b/docs/zh-CN/developer/developer-guide/docker-dev.md @@ -29,8 +29,8 @@ under the License. ## 相关详细文档导航 -- [使用 Docker 开发镜像编译](../install/source-install/compilation.md) -- [部署](../install/install-deploy.md) +- [使用 Docker 开发镜像编译](../../docs/install/source-install/compilation.md) +- [部署](../../docs/install/install-deploy.md) - [VSCode Be 开发调试](./be-vscode-dev.md) ## 环境准备 @@ -90,7 +90,7 @@ docker build -t doris . 运行镜像 -此处按需注意 [挂载的问题](../install/source-install/compilation.md) +此处按需注意 [挂载的问题](../../docs/install/source-install/compilation.md) > 见链接中：建议以挂载本地 Doris 源码目录的方式运行镜像 ..... diff --git a/docs/zh-CN/developer/developer-guide/fe-vscode-dev.md b/docs/zh-CN/developer/developer-guide/fe-vscode-dev.md index bbc5834281..b5700956dd 100644 --- a/docs/zh-CN/developer/developer-guide/fe-vscode-dev.md +++ b/docs/zh-CN/developer/developer-guide/fe-vscode-dev.md @@ -72,7 +72,7 @@ example: ## 编译 其他文章已经介绍的比较清楚了： -* [使用 LDB toolchain 编译](../install/source-install/compilation-with-ldb-toolchain.md) +* [使用 LDB toolchain 编译](../../docs/install/source-install/compilation-with-ldb-toolchain.md) * ...... 为了进行调试，需要在 fe 启动时，加上调试的参数，比如 `-agentlib:jdwp=transport=dt_socket,server=y,suspend=n,address=5005` 。 diff --git a/docs/zh-CN/developer/developer-guide/how-to-share-blogs.md b/docs/zh-CN/developer/developer-guide/how-to-share-blogs.md index 0b453928d5..fc61dd9480 100644 --- a/docs/zh-CN/developer/developer-guide/how-to-share-blogs.md +++ b/docs/zh-CN/developer/developer-guide/how-to-share-blogs.md @@ -36,4 +36,4 @@ Doris 社区欢迎大家分享 Doris 相关的文章。这些文章一经合入 * Doris 功能原理解读 * Doris 业务场景实践 -具体说明，请前往：https://github.com/apache/incubator-doris-website 参阅 [README](https://github.com/apache/incubator-doris-website) +具体说明，请前往：https://github.com/apache/doris-website 参阅 [README](https://github.com/apache/doris-website)