Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Doc] Update fe-idea developer guide for latest version #6963

Merged
merged 2 commits into from
Nov 1, 2021
Merged

[Doc] Update fe-idea developer guide for latest version #6963

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
adb713f
[Doc] Update fe-idea developer guide for latest version
Oct 28, 2021
7514350
[Doc] Add version note of thrift installation
Oct 29, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 6 additions & 4 deletions docs/en/developer-guide/fe-idea-dev.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,12 +43,12 @@ If your are only interested in FE module, and for some reason you can't or don't
the minimum tool required for FE module is `thrift`, so you can manually install `thrift` and copy or create a link of
the executable `thrift` command to `./thirdparty/installed/bin`.

Doris build against `thrift` 0.9.3, and `thrift` 0.9.3.1 should also work well, but the newer version will not.
Doris build against `thrift` 0.13.0 ( note : `Doris` 0.15 and later version build against `thrift` 0.13.0 , the previous version is still `thrift` 0.9.3)

If your are using macOS, try `brew install thrift@0.9` and will get `thrift` 0.9.3.1 installed at `/usr/local/opt/thrift@0.9/bin/thrift`,
If your are using macOS, try `brew install thrift@0.13.0` and will get `thrift` 0.13.0 installed at `/usr/local/opt/thrift@0.13.0/bin/thrift`,
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same as above

then create a soft link to `./thirdparty/installed/bin/thrift`.

For Windows users, download `thrift` 0.9.3 from `http://archive.apache.org/dist/thrift/0.9.3/thrift-0.9.3.exe`,
For Windows users, download `thrift` 0.13.0 from `http://archive.apache.org/dist/thrift/0.13.0/thrift-0.13.0.exe`,
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same as above

and put it into `thirdparty/installed/bin/` folder.

Go to `./fe` folder and run the following maven command to generate sources.
Expand All @@ -74,10 +74,12 @@ is generate codes in Linux and copy them back. Using Docker should also be an op

1. Import `./fe` into IDEA

2. Follow the picture to create the folders and copy files under `webroot` into it.
2. Follow the picture to create the folders

![](/images/DEBUG4.png)

3. Build `ui` project , and copy files from directory `ui/dist` into directory `webroot` ( you can skip this step , if you don't need `Doris` UI )

## Custom FE configuration

Copy below content into `conf/fe.conf` and tune it to fit your environment.
Expand Down
14 changes: 8 additions & 6 deletions docs/zh-CN/developer-guide/fe-idea-dev.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,10 +36,10 @@ JDK1.8+, IntelliJ IDEA

3. 如果仅进行fe开发而没有编译过thirdparty，则需要安装thrift，并将thrift 复制或者连接到 `thirdparty/installed/bin` 目录下

1. 安装 thrift 0.9.3 版本(注意：Doris 基于 thrift 0.9.3 构建, 使用新版本会导致编译不通过)

MacOS: `brew install thrift@0.9`
Windows: `http://archive.apache.org/dist/thrift/0.9.3/thrift-0.9.3.exe`
安装 `thrift` 0.13.0 版本(注意：`Doris` 0.15 和最新的版本基于 `thrift` 0.13.0 构建, 之前的版本依然使用`thrift` 0.9.3 构建)
MacOS: `brew install thrift@0.13.0`
Windows: `http://archive.apache.org/dist/thrift/0.13.0/thrift-0.13.0.exe`

4. 如果是Mac 或者 Linux 环境 可以通过 如下命令生成自动生成代码：

Expand All @@ -62,12 +62,14 @@ JDK1.8+, IntelliJ IDEA

## 2.调试

**1. 用idea导入fe工程；**
1. 用idea导入fe工程

2.在fe目录下创建下面红框标出的目录，并将webroot里的内容拷贝进去
2. 在fe目录下创建下面红框标出的目录

![](/images/DEBUG4.png)

3. 编译`ui`项目，将 `ui/dist/`目录中的文件拷贝到`webroot`中（如果你不需要看`Doris` UI，这一步可以跳过）

## 3.配置conf/fe.conf

下面是我自己的配置，你可以根据自己的需要进行修改
Expand Down