Skip to content

Commit

Permalink
[typo](fix)Fix community documentation link errors (apache#11758)
Browse files Browse the repository at this point in the history
Fix community documentation link errors
  • Loading branch information
hf200012 authored Aug 13, 2022
1 parent db83f37 commit 031fba4
Show file tree
Hide file tree
Showing 34 changed files with 986 additions and 248 deletions.
2 changes: 1 addition & 1 deletion docs/en/community/design/grouping_sets_design.md
Original file line number Diff line number Diff line change
Expand Up @@ -138,7 +138,7 @@ Indicates whether a specified column expression in a `GROUP BY` list is aggregat

`GROUPING_ID` describes which of a list of expressions are grouped in a row produced by a `GROUP BY` query. The `GROUPING_ID` function simply returns the decimal equivalent of the binary value formed as a result of the concatenation of the values returned by the `GROUPING` functions.

Each `GROUPING_ID` argument must be an element of the `GROUP BY` list. `GROUPING_ID ()` returns an **integer** bitmap whose lowest N bits may be lit. A lit **bit** indicates the corresponding argument is not a grouping column for the given output row. The lowest-order **bit** corresponds to argument N, and the N-1th lowest-order **bit** corresponds to argument 1. If the column is a grouping column the bit is 1 else is 0.
Each `GROUPING_ID` argument must be an element of the `GROUP BY` list. `GROUPING_ID ()` returns an **integer** bitmap whose lowest N bits may be lit. A lit **bit** indicates the corresponding argument is not a grouping column for the given output row. The lowest-order **bit** corresponds to argument N, and the N-1th lowest-order **bit** corresponds to argument 1. If the column is a grouping column the bit is 0 else is 1.

For example:

Expand Down
2 changes: 1 addition & 1 deletion docs/en/community/developer-guide/benchmark-tool.md
Original file line number Diff line number Diff line change
Expand Up @@ -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](../../docs/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)

2. Execute`run-be-ut.sh`

Expand Down
2 changes: 1 addition & 1 deletion docs/en/community/developer-guide/cpp-diagnostic-code.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ 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](../../docs/install/source-install/compilation-with-ldb-toolchain.md),also can install by self.
to diagnostic code. Clangd and Clang-Tidy already has in [LDB-toolchain](/docs/install/source-install/compilation-with-ldb-toolchain),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.
Expand Down
2 changes: 1 addition & 1 deletion docs/en/community/developer-guide/cpp-format-code.md
Original file line number Diff line number Diff line change
Expand Up @@ -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](../../docs/install/source-install/compilation-with-ldb-toolchain.md),
If you are using [LDB toolchain](/docs/install/source-install/compilation-with-ldb-toolchain),
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
Expand Down
10 changes: 5 additions & 5 deletions docs/en/community/developer-guide/docker-dev.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,9 +29,9 @@ under the License.

## Related detailed document navigation

- [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)
- [Developing mirror compilation using Docker](/docs/install/source-install/compilation)
- [Deploying Doris](/docs/install/install-deploy)
- [VSCode Be Development Debugging](./be-vscode-dev)

## Environment preparation

Expand Down Expand Up @@ -90,7 +90,7 @@ docker build -t doris .

run image

note! [problems with mounting](../../docs/install/source-install/compilation.md)
note! [problems with mounting](../../docs/install/source-install/compilation)

> See the link above: It is recommended to run the image by mounting the local Doris source code directory as a volume .....
Expand All @@ -111,7 +111,7 @@ create directory and download doris
```bash
su <your user>
mkdir code && cd code
git clone https://github.com/apache/incubator-doris.git
git clone https://github.com/apache/doris.git
```

## Compile
Expand Down
181 changes: 115 additions & 66 deletions docs/en/community/developer-guide/fe-idea-dev.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,86 +28,64 @@ under the License.

## 1. Environmental Preparation

* Git
* JDK1.8+
* IntelliJ IDEA
* Maven (Optional, IDEA shipped embedded Maven3)

Git clone codebase from https://github.com/apache/incubator-doris.git
1. Git clone codebase from https://github.com/apache/doris.git

Use IntelliJ IDEA to open the code `FE` directory

### Thrift
2. Use IntelliJ IDEA to open the code root directory

If your are only interested in FE module, and for some reason you can't or don't want to compile full thirdparty libraries,

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.13.0 ( note : `Doris` 0.15 and later version build against `thrift` 0.13.0 , the previous version is still `thrift` 0.9.3)
Windows:
1. Download:`http://archive.apache.org/dist/thrift/0.13.0/thrift-0.13.0.exe`
2. Copy:copy the file to `./thirdparty/installed/bin`
3. If your are only interested in FE module, and for some reason you can't or don't want to compile full thirdparty libraries,
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.13.0 ( note : `Doris` 0.15 and later version build against `thrift` 0.13.0 , the previous version is still `thrift` 0.9.3)
MacOS:
1. Download:`brew install thrift@0.13.0`
2. Establish soft connection:
`mkdir -p ./thirdparty/installed/bin`
# For ARM macOS
`ln -s /opt/homebrew/Cellar/thrift@0.13.0/0.13.0/bin/thrift ./thirdparty/installed/bin/thrift`
# For Intel macOS
`ln -s /usr/local/Cellar/thrift@0.13.0/0.13.0/bin/thrift ./thirdparty/installed/bin/thrift`
Windows:
1. Download:`http://archive.apache.org/dist/thrift/0.13.0/thrift-0.13.0.exe`
2. Copy:copy the file to `./thirdparty/installed/bin`
MacOS:
1. Download:`brew install thrift@0.13.0`
2. Establish soft connection:
`mkdir -p ./thirdparty/installed/bin`
# For ARM macOS
`ln -s /opt/homebrew/Cellar/thrift@0.13.0/0.13.0/bin/thrift ./thirdparty/installed/bin/thrift`
# For Intel macOS
`ln -s /usr/local/Cellar/thrift@0.13.0/0.13.0/bin/thrift ./thirdparty/installed/bin/thrift`
Note:The error that the version cannot be found may be reported when MacOS execute `brew install thrift@0.13.0`. The solution is execute at the terminal as follows:
1. `brew tap-new $USER/local-tap`
2. `brew extract --version='0.13.0' thrift $USER/local-tap`
3. `brew install thrift@0.13.0`
Reference link: `https://gist.github.com/tonydeng/02e571f273d6cce4230dc8d5f394493c`
```

4. Go to `./fe` folder and run the following maven command to generate sources.

```
mvn generate-sources
```

Note:The error that the version cannot be found may be reported when MacOS execute `brew install thrift@0.13.0`. The solution is execute at the terminal as follows:
1. `brew tap-new $USER/local-tap`
2. `brew extract --version='0.13.0' thrift $USER/local-tap`
3. `brew install thrift@0.13.0`
Reference link: `https://gist.github.com/tonydeng/02e571f273d6cce4230dc8d5f394493c`
```

### generate sources

Go to `./fe` folder and run the following maven command to generate sources.

```
mvn generate-sources
```

If fails, run following command.

```
mvn clean install -DskipTests
```

You can also use IDE embedded GUI tools to run maven command to generate sources
If fails, run following command.

```
mvn clean install -DskipTests
```

You can also use IDE embedded GUI tools to run maven command to generate sources

![](/images/gen_code.png)

If you are developing on the OS which lack of support to run `shell script` and `make` such as Windows, a workround here
is generate codes in Linux and copy them back. Using Docker should also be an option.

#### arm mac compile failed

An error would occur if you generated sources using maven on arm mac. Detailed error messages are as follows.

```
[ERROR] Failed to execute goal org.xolstice.maven.plugins:protobuf-maven-plugin:0.6.1:compile (grpc-build) on project apm-network: Unable to resolve artifact: Missing:
[ERROR] 1) com.google.protobuf:protoc:exe:osx-aarch_64:3.14.0
[ERROR] 1 required artifact is missing.
```

Since protobuf v3.14.0 and protoc-gen-grpc-java v1.30.0 don't come up with osx-aarch_64 version, given the advice by [grpc_community], you'd better manually download the corresponding osx_x86 version and then translate them by Rosseta2.

1. open `doris/fe/fe-core/pom.xml`
2. change `<protocArtifact>com.google.protobuf:protoc:${protobuf.version}</protocArtifact>` to `<protocArtifact>com.google.protobuf:protoc:3.14.0:exe:osx-x86_64</protocArtifact>`
3. change `<pluginArtifact>io.grpc:protoc-gen-grpc-java:${grpc.version}</pluginArtifact>` to `<pluginArtifact>io.grpc:protoc-gen-grpc-java:1.30.0:exe:osx-x86_64</pluginArtifact>`
4. open terminal and paste `softwareupdate --install-rosetta`

### help document

If a help document has not been generated, go to the docs directory and run `sh build_help_zip.sh`

Then copy help-resource.zip from build to fe/fe-core/target/classes
5. If a help document has not been generated, go to the docs directory and run`sh build_help_zip.sh`
Then copy help-resource.zip from build to fe/fe-core/target/classes

## 2. Debug

Expand All @@ -121,9 +99,80 @@ Then copy help-resource.zip from build to fe/fe-core/target/classes

## 3. Custom FE configuration

Copy below content into `conf/fe.conf` and tune it to fit your environment
Copy below content into `conf/fe.conf` and tune it to fit your environment(Note: If developed using`Mac`, since`docker for Mac`does not support`Host`mode,`be`needs to be exposed using`-p` and `fe.conf` `priority_networks` configured to be accessible within the container, such as WIFI Ip).

(Note: If developed using`Mac`, since`docker for Mac`does not support`Host`mode,`be`needs to be exposed using`-p` and `fe.conf` `priority_networks` configured to be accessible within the container, such as WIFI Ip).
```
# 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.
#####################################################################
## The uppercase properties are read and exported by bin/start_fe.sh.
## To see all Frontend configurations,
## see fe/src/org/apache/doris/common/Config.java
#####################################################################
# the output dir of stderr and stdout
LOG_DIR = ${DORIS_HOME}/log
DATE = `date +%Y%m%d-%H%M%S`
JAVA_OPTS="-Xmx2048m -XX:+UseMembar -XX:SurvivorRatio=8 -XX:MaxTenuringThreshold=7 -XX:+PrintGCDateStamps -XX:+PrintGCDetails -XX:+UseConcMarkSweepGC -XX:+UseParNewGC -XX:+CMSClassUnloadingEnabled -XX:-CMSParallelRemarkEnabled -XX:CMSInitiatingOccupancyFraction=80 -XX:SoftRefLRUPolicyMSPerMB=0 -Xloggc:$DORIS_HOME/log/fe.gc.log.$DATE"
# For jdk 9+, this JAVA_OPTS will be used as default JVM options
JAVA_OPTS_FOR_JDK_9="-Xmx4096m -XX:SurvivorRatio=8 -XX:MaxTenuringThreshold=7 -XX:+CMSClassUnloadingEnabled -XX:-CMSParallelRemarkEnabled -XX:CMSInitiatingOccupancyFraction=80 -XX:SoftRefLRUPolicyMSPerMB=0 -Xlog:gc*:$DORIS_HOME/log/fe.gc.log.$DATE:time"
##
## the lowercase properties are read by main program.
##
# INFO, WARN, ERROR, FATAL
sys_log_level = INFO
# store metadata, create it if it is not exist.
# Default value is ${DORIS_HOME}/doris-meta
# meta_dir = ${DORIS_HOME}/doris-meta
http_port = 8030
rpc_port = 9020
query_port = 9030
edit_log_port = 9010
mysql_service_nio_enabled = true
# Choose one if there are more than one ip except loopback address.
# Note that there should at most one ip match this list.
# If no ip match this rule, will choose one randomly.
# use CIDR format, e.g. 10.10.10.0/24
# Default value is empty.
# priority_networks = 10.10.10.0/24;192.168.0.0/16
# Advanced configurations
# log_roll_size_mb = 1024
# sys_log_dir = ${DORIS_HOME}/log
# sys_log_roll_num = 10
# sys_log_verbose_modules =
# audit_log_dir = ${DORIS_HOME}/log
# audit_log_modules = slow_query, query
# audit_log_roll_num = 10
# meta_delay_toleration_second = 10
# qe_max_connection = 1024
# max_conn_per_user = 100
# qe_query_timeout_second = 300
# qe_slow_log_ms = 5000
```

## 4. Setting Environment Variables

Expand Down
4 changes: 2 additions & 2 deletions docs/en/community/developer-guide/fe-vscode-dev.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ Some developers are building FE development environment on a development machine

## Download code for compilation

1. https://github.com/apache/incubator-doris.git Download the doris source code
1. https://github.com/apache/doris.git Download the doris source code

2. use VSCode to open the code `/fe` directory

Expand Down Expand Up @@ -72,7 +72,7 @@ example:
## Build

Other articles have already explained:
* [Build with LDB toolchain ](../../docs/install/source-install/compilation-with-ldb-toolchain.md)
* [Build with LDB toolchain ](/docs/install/source-install/compilation-with-ldb-toolchain)
* ......

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` .
Expand Down
30 changes: 30 additions & 0 deletions docs/en/community/developer-guide/regression-testing.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
---
{
"title": "Regression Testing",
"language": "en"
}

---

<!--
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.
-->

# Regression Testing

TODO
2 changes: 1 addition & 1 deletion docs/en/community/feedback.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,4 +42,4 @@ If you find any problems or suggestions while using Doris, you can provide feedb

2. Github

Submit a [Github Issue](https://github.com/apache/incubator-doris/issues/new/choose)
Submit a [Github Issue](https://github.com/apache/doris/issues/new/choose)
Loading

0 comments on commit 031fba4

Please sign in to comment.