This is an automated email from the ASF dual-hosted git repository.
jiafengzheng pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/doris.git
The following commit(s) were added to refs/heads/master by this push:
new 031fba4259 [typo](fix)Fix community documentation link errors (#11758)
031fba4259 is described below
commit 031fba4259ec22f4c042b3510c41adc06cae6925
Author: jiafeng.zhang <zhang...@gmail.com>
AuthorDate: Sat Aug 13 21:24:54 2022 +0800
[typo](fix)Fix community documentation link errors (#11758)
Fix community documentation link errors
---
docs/en/community/design/grouping_sets_design.md | 2 +-
.../en/community/developer-guide/benchmark-tool.md | 2 +-
.../developer-guide/cpp-diagnostic-code.md | 2 +-
.../community/developer-guide/cpp-format-code.md | 2 +-
docs/en/community/developer-guide/docker-dev.md | 10 +-
docs/en/community/developer-guide/fe-idea-dev.md | 181 +++++++-----
docs/en/community/developer-guide/fe-vscode-dev.md | 4 +-
.../developer-guide/regression-testing.md | 30 ++
docs/en/community/feedback.md | 2 +-
.../community/how-to-contribute/contribute-doc.md | 313 +++++++++++++++++++++
.../how-to-contribute/contributor-guide.md | 2 +-
.../how-to-contribute/how-to-contribute.md | 32 +--
.../en/community/how-to-contribute/pull-request.md | 12 +-
.../release-and-verify/release-doris-connectors.md | 2 +-
.../release-and-verify/release-doris-core.md | 2 +-
.../release-and-verify/release-doris-manager.md | 2 +-
docs/en/community/subscribe-mail-list.md | 2 +-
docs/en/community/team.md | 2 +-
.../zh-CN/community/design/grouping_sets_design.md | 2 +-
.../community/developer-guide/be-vscode-dev.md | 43 ++-
.../community/developer-guide/benchmark-tool.md | 2 +-
.../developer-guide/cpp-diagnostic-code.md | 2 +-
.../community/developer-guide/cpp-format-code.md | 4 +-
docs/zh-CN/community/developer-guide/docker-dev.md | 10 +-
.../zh-CN/community/developer-guide/fe-idea-dev.md | 197 +++++++------
.../community/developer-guide/fe-vscode-dev.md | 4 +-
.../developer-guide/regression-testing.md | 16 +-
.../community/how-to-contribute/contribute-doc.md | 312 ++++++++++++++++++++
.../how-to-contribute/contributor-guide.md | 2 +-
.../how-to-contribute/how-to-be-a-committer.md | 2 +-
.../how-to-contribute/how-to-contribute.md | 26 +-
.../community/how-to-contribute/pull-request.md | 4 +-
.../release-and-verify/release-doris-core.md | 2 +-
docs/zh-CN/community/team.md | 2 +-
34 files changed, 986 insertions(+), 248 deletions(-)
diff --git a/docs/en/community/design/grouping_sets_design.md
b/docs/en/community/design/grouping_sets_design.md
index 483f1ee856..16acc33997 100644
--- a/docs/en/community/design/grouping_sets_design.md
+++ b/docs/en/community/design/grouping_sets_design.md
@@ -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:
diff --git a/docs/en/community/developer-guide/benchmark-tool.md
b/docs/en/community/developer-guide/benchmark-tool.md
index 21cacc9656..a6ed29e12a 100644
--- a/docs/en/community/developer-guide/benchmark-tool.md
+++ b/docs/en/community/developer-guide/benchmark-tool.md
@@ -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`
diff --git a/docs/en/community/developer-guide/cpp-diagnostic-code.md
b/docs/en/community/developer-guide/cpp-diagnostic-code.md
index e0051209f2..b4fa4f042a 100644
--- a/docs/en/community/developer-guide/cpp-diagnostic-code.md
+++ b/docs/en/community/developer-guide/cpp-diagnostic-code.md
@@ -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.
diff --git a/docs/en/community/developer-guide/cpp-format-code.md
b/docs/en/community/developer-guide/cpp-format-code.md
index 4670a9bdaf..937ba7b464 100644
--- a/docs/en/community/developer-guide/cpp-format-code.md
+++ b/docs/en/community/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](../../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
diff --git a/docs/en/community/developer-guide/docker-dev.md
b/docs/en/community/developer-guide/docker-dev.md
index 8b164e856c..ccf855dd60 100644
--- a/docs/en/community/developer-guide/docker-dev.md
+++ b/docs/en/community/developer-guide/docker-dev.md
@@ -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
@@ -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 .....
@@ -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
diff --git a/docs/en/community/developer-guide/fe-idea-dev.md
b/docs/en/community/developer-guide/fe-idea-dev.md
index 83931d75be..40fc8ccf06 100644
--- a/docs/en/community/developer-guide/fe-idea-dev.md
+++ b/docs/en/community/developer-guide/fe-idea-dev.md
@@ -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
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
@@ -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
diff --git a/docs/en/community/developer-guide/fe-vscode-dev.md
b/docs/en/community/developer-guide/fe-vscode-dev.md
index fe8840e08c..95dc4650c5 100644
--- a/docs/en/community/developer-guide/fe-vscode-dev.md
+++ b/docs/en/community/developer-guide/fe-vscode-dev.md
@@ -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
@@ -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` .
diff --git a/docs/en/community/developer-guide/regression-testing.md
b/docs/en/community/developer-guide/regression-testing.md
new file mode 100644
index 0000000000..c5981fd3ca
--- /dev/null
+++ b/docs/en/community/developer-guide/regression-testing.md
@@ -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
\ No newline at end of file
diff --git a/docs/en/community/feedback.md b/docs/en/community/feedback.md
index 64e1d46fd1..9774c1f053 100644
--- a/docs/en/community/feedback.md
+++ b/docs/en/community/feedback.md
@@ -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)
diff --git a/docs/en/community/how-to-contribute/contribute-doc.md
b/docs/en/community/how-to-contribute/contribute-doc.md
new file mode 100644
index 0000000000..4429171007
--- /dev/null
+++ b/docs/en/community/how-to-contribute/contribute-doc.md
@@ -0,0 +1,313 @@
+---
+{
+ "title": "Docs Contribute",
+ "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.
+-->
+
+# Doris Documentation Contributions
+
+Here we mainly introduce how to modify and contribute to Doris' documents.
+
+How to submit your document modification, please refer to
+
+[Contribute to Doris](./)
+
+[Code Submission Guidelines](./pull-request)
+
+Documents of historical versions can be submitted directly on
[apache/doris-website](https://github.com/apache/doris-website) PR, if it is
the latest version, it needs to be in [apache/doris-website]
(https://github.com/apache/doris-website) and the
[apache/doris](https://github.com/apache/doris) codebase at the same time
commit changes.
+
+The following introduces the directory structure of the Doris Website site to
facilitate users to modify and submit documents
+
+## Doris Website Directory Structure
+
+
+
+````
+.
+├── README.md
+├── babel.config.js
+├── blog
+│ ├── 1.1 Release.md
+│ ├── Annoucing.md
+│ ├── jd.md
+│ ├── meituan.md
+│ ├── release-note-0.15.0.md
+│ ├── release-note-1.0.0.md
+│ └── xiaomi.md
+├── build.sh
+├── community
+│ ├── design
+│ │ ├── Flink-doris-connector-Design.md
+│ │ ├── doris_storage_optimization.md
+│ │ ├── grouping_sets_design.md
+│ │ └── metadata-design.md
+│ ├──
+├── docs
+│ ├── admin-manual
+│ │ ├── cluster-management
+│ │ ├── config
+│ │ ├── data-admin
+│ │ ├── http-actions
+│ │ ├── maint-monitor
+│ │ ├── multi-tenant.md
+│ │ ├── optimization.md
+│ │ ├── privilege-ldap
+│ │ ├── query-profile.md
+│ │ └── sql-interception.md
+│ ├──
+├── docusaurus.config.js
+├── i18n
+│ └── en-US
+│ ├── code.json
+│ ├── docusaurus-plugin-content-blog
+│ ├── docusaurus-plugin-content-docs
+│ ├── docusaurus-plugin-content-docs-community
+│ └── docusaurus-theme-classic
+├── package.json
+├── sidebars.json
+├── sidebarsCommunity.json
+├── src
+│ ├── components
+│ │ ├── Icons
+│ │ ├── More
+│ │ ├── PageBanner
+│ │ └── PageColumn
+│ ├──
+├── static
+│ ├── images
+│ │ ├── Bloom_filter.svg.png
+│ │ ├── .....
+│ └── js
+│ └── redirect.js
+├── tree.out
+├── tsconfig.json
+├── versioned_docs
+│ ├── version-0.15
+│ │ ├── administrator-guide
+│ │ ├── best-practices
+│ │ ├── extending-doris
+│ │ ├── getting-started
+│ │ ├── installing
+│ │ ├── internal
+│ │ ├── sql-reference
+│ │ └── sql-reference-v2
+│ └── version-1.0
+│ ├── administrator-guide
+│ ├── benchmark
+│ ├── extending-doris
+│ ├── faq
+│ ├── getting-started
+│ ├── installing
+│ ├── internal
+│ ├── sql-reference
+│ └── sql-reference-v2
+├── versioned_sidebars
+│ ├── version-0.15-sidebars.json
+│ └── version-1.0-sidebars.json
+├── versions.json
+
+````
+
+Directory structure description:
+
+1. Blog Directory
+
+ - The English blog directory is under the blog in the root directory, and
the English files of all blogs are placed in this directory
+ - The directory of the Chinese blog is in the
`i18n/zh-CN/docusaurus-plugin-content-blog` directory, all Chinese blog files
are placed under this
+ - The file names of Chinese and English blogs should be the same
+
+2. Document Content Directory
+
+ - The latest version of the English document content is under docs in the
root directory
+
+ - The version of the English documentation is under `versioned_docs/` in
the root directory
+
+ - This directory only holds documents from historical versions
+
+ ````
+ .
+ ├── version-0.15
+ │ ├── administrator-guide
+ │ ├── best-practices
+ │ ├── extending-doris
+ │ ├── getting-started
+ │ ├── installing
+ │ ├── internal
+ │ ├── sql-reference
+ │ └── sql-reference-v2
+ └── version-1.0
+ ├── administrator-guide
+ ├── benchmark
+ ├── extending-doris
+ ├── faq
+ ├── getting-started
+ ├── installing
+ ├── internal
+ ├── sql-reference
+ └── sql-reference-v2
+ ````
+
+ - Versioning of English documents is under `versioned_sidebars` in the
root directory
+
+ ````
+ .
+ ├── version-0.15-sidebars.json
+ └── version-1.0-sidebars.json
+ ````
+
+ The json file here is written according to the directory structure of
the corresponding version
+
+ - Chinese documentation at `i18n/zh-CN/docusaurus-plugin-content-docs`
+
+ - Below this corresponds to different version directories and json files
corresponding to the version, as follows
+
+ current is the current latest version of the document. The example
corresponds to version 1.1. When modifying, according to the document version
to be modified, find the corresponding file modification in the corresponding
directory and submit it.
+
+ ````
+ .
+ ├── current
+ │ ├── admin-manual
+ │ ├── advanced
+ │ ├── benchmark
+ │ ├── data-operate
+ │ ├── data-table
+ │ ├── ecosystem
+ │ ├── faq
+ │ ├── get-starting
+ │ ├── install
+ │ ├── sql-manual
+ │ └── summary
+ ├── current.json
+ ├── version-0.15
+ │ ├── administrator-guide
+ │ ├── best-practices
+ │ ├── extending-doris
+ │ ├── getting-started
+ │ ├── installing
+ │ ├── internal
+ │ ├── sql-reference
+ │ └── sql-reference-v2
+ ├── version-0.15.json
+ ├── version-1.0
+ │ ├── administrator-guide
+ │ ├── benchmark
+ │ ├── extending-doris
+ │ ├── faq
+ │ ├── getting-started
+ │ ├── installing
+ │ ├── internal
+ │ ├── sql-reference
+ │ └── sql-reference-v2
+ └── version-1.0.json
+ ````
+
+ - Version Json file
+
+ Current.json corresponds to the Chinese translation of the latest
version of the document, for example:
+
+ ````json
+ {
+ "version.label": {
+ "message": "1.1",
+ "description": "The label for version current"
+ },
+ "sidebar.docs.category.Getting Started": {
+ "message": "Quick Start",
+ "description": "The label for category Getting Started in sidebar
docs"
+ }
+ .....
+ }
+ ````
+
+ Here `sidebar.docs.category.Getting Started` corresponds to `label` in
`sidebars.json` in the root directory
+
+ For example, the `sidebar.docs.category.Getting Started` just now
corresponds to the `sidebar` prefix and the structure in `sidebars.json`
+
+ The first is `sidebar + "." + docs + ".'" + [ type ] + [ label ] `.
+
+ ````json
+ {
+ "docs": [
+ {
+ "type": "category",
+ "label": "Getting Started",
+ "items": [
+ "get-starting/get-starting"
+ ]
+ },
+ {
+ "type": "category",
+ "label": "Doris Introduction",
+ "items": [
+ "summary/basic-summary"
+ ]
+ }
+ .....
+ }
+ ````
+
+ - Support label translation in the Chinese version json file, no need to
describe the document hierarchy, which is described in the `sidebar.json` file
+
+ - All documents must be in English, and Chinese can only be displayed. If
English is not written, you can create an empty file, otherwise Chinese
documents will not be displayed. This applies to all blogs, documents, and
community content
+
+2. Community Documentation
+
+ This document does not distinguish between versions and is generic
+
+ - English documentation is under the `community/` directory in the root
directory.
+
+ - Chinese documentation is under
`i18n/zh-CN/docusaurus-plugin-content-docs-community/` directory.
+
+ - The directory structure of community documents is controlled in the
`sidebarsCommunity.json` file in the root directory,
+
+ - The Chinese translation corresponding to the community documentation
directory structure is in the
`i18n/zh-CN/docusaurus-plugin-content-docs-community/current.json` file
+
+ ````json
+ {
+ "version.label": {
+ "message": "Next",
+ "description": "The label for version current"
+ },
+ "sidebar.community.category.How to Contribute": {
+ "message": "Contribution Guidelines",
+ "description": "The label for category How to Contribute in sidebar
community"
+ },
+ "sidebar.community.category.Release Process & Verification": {
+ "message": "Version release and verification",
+ "description": "The label for category Release Process & Verification
in sidebar community"
+ },
+ "sidebar.community.category.Design Documents": {
+ "message": "Design document",
+ "description": "The label for category Design Documents in sidebar
community"
+ },
+ "sidebar.community.category.Developer Guide": {
+ "message": "Developer's Manual",
+ "description": "The label for category Developer Guide in sidebar
community"
+ }
+ }
+ ````
+
+3. Pictures
+
+ All images are in the `static/images` directory
\ No newline at end of file
diff --git a/docs/en/community/how-to-contribute/contributor-guide.md
b/docs/en/community/how-to-contribute/contributor-guide.md
index dfb700f11c..8e96cfa335 100644
--- a/docs/en/community/how-to-contribute/contributor-guide.md
+++ b/docs/en/community/how-to-contribute/contributor-guide.md
@@ -43,7 +43,7 @@ If you are PPMC, you can subscribe the mailing list through
[Subscription Helper
We use Github for managing issues and user contributions (pull requests).
As such, you need to link your Github.com account with your ASF account using
[Gitbox](https://gitbox.apache.org/setup/).
-This way you will get write access to
[Doris](https://github.com/apache/incubator-doris) repository
+This way you will get write access to [Doris](https://github.com/apache/doris)
repository
and you will be able to manage issues and pull request directly through our
Github repository.
## Code Review Guidelines
diff --git a/docs/en/community/how-to-contribute/how-to-contribute.md
b/docs/en/community/how-to-contribute/how-to-contribute.md
index 11795417ff..bdd3d03d4e 100644
--- a/docs/en/community/how-to-contribute/how-to-contribute.md
+++ b/docs/en/community/how-to-contribute/how-to-contribute.md
@@ -28,7 +28,7 @@ under the License.
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/choose).
+Your suggestions, comments and comments on Doris can be made directly through
GitHub's [Issues](https://github.com/apache/doris/issues/new/choose).
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](http://people.apache.org/committer-index.html).
@@ -38,8 +38,8 @@ Any questions, you can contact us to get timely answers,
including Wechat, Gitte
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);
+* Follow [Doris Github](https://github.com/apache/doris)
+* Subscribe to our [mailing list](./subscribe-mail-list);
* Join Doris Wechat Group (add WeChat-ID: morningman-cmy, note: join Doris
Group) and ask questions at any time.
* Enter Doris's
[Slack](https://join.slack.com/t/apachedoriscommunity/shared_invite/zt-11jb8gesh-7IukzSrdea6mqoG0HB4gZg)
@@ -47,17 +47,17 @@ Learn the development trends of Doris project in time and
give your opinions on
## 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:
+As you can see from [GitHub](https://github.com/apache/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 |
-| [Manager](https://github.com/apache/incubator-doris-manager) | Doris Manager
| Java |
-| [Flink-Connector](https://github.com/apache/incubator-doris-flink-connector)
| Doris Flink Connector | Java |
-| [Spark-Connector](https://github.com/apache/incubator-doris-spark-connector)
| Doris Spark Connector | Java |
+| [Frontend daemon (FE)](https://github.com/apache/doris) | consists of a
query coordinator and a metadata manager | Java|
+| [Backend daemon (BE)](https://github.com/apache/doris) | Responsible for
storing data and executing query fragments | C++|
+| [Broker](https://github.com/apache/doris) | Read HDFS data to Doris | Java|
+| [Website](https://github.com/apache/doris-website) | Doris Website |
Markdown |
+| [Manager](https://github.com/apache/doris-manager) | Doris Manager | Java |
+| [Flink-Connector](https://github.com/apache/doris-flink-connector) | Doris
Flink Connector | Java |
+| [Spark-Connector](https://github.com/apache/doris-spark-connector) | Doris
Spark Connector | Java |
| Doris Runtime Help Document | Online Help Manual at Doris Runtime | Markdown|
## Improving documentation
@@ -68,18 +68,18 @@ Browse the document, you can deepen your understanding of
Doris, can also help y
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).
+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/doris). If you submit code changes, you can
refer to [Pull Request](./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](https://github.com/apache/incubator-doris/issues/new/choose),
and we will have someone deal with it regularly.
+If a Bug or problem is found, you can directly raise a new Issue through
GitHub's [Issues](https://github.com/apache/doris/issues/new/choose), 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).
+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).
## 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](../../install/source-install/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.
+You can download the code, compile and install it, deploy and run it for a try
(refer to the [compilation document](/docs/install/source-install/compilation)
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).
+About how to submit a PR refer to [Pull Request](./pull-request).
diff --git a/docs/en/community/how-to-contribute/pull-request.md
b/docs/en/community/how-to-contribute/pull-request.md
index ecf3220ef9..f7cf3ac73e 100644
--- a/docs/en/community/how-to-contribute/pull-request.md
+++ b/docs/en/community/how-to-contribute/pull-request.md
@@ -26,11 +26,11 @@ under the License.
# Code Submission Guide
-[Pull Request (PR)](https://help.github.com/articles/about-pull-requests/) can
be easily submitted on [Github](https://github.com/apache/incubator-doris). The
PR method of Doris project is described below.
+[Pull Request (PR)](https://help.github.com/articles/about-pull-requests/) can
be easily submitted on [Github](https://github.com/apache/doris). The PR method
of Doris project is described below.
## Fork Repository
-Go to the [github page](https://github.com/apache/incubator-doris) of
apache/incubator-doris , and click the button `Fork` in the upper right corner
for Fork.
+Go to the [github page](https://github.com/apache/doris) of apache/doris , and
click the button `Fork` in the upper right corner for Fork.
@@ -39,17 +39,17 @@ Go to the [github
page](https://github.com/apache/incubator-doris) of apache/inc
#### (1) Clone the code locally:
```
-git clone https://github.com/<your_github_name>/incubator-doris.git
+git clone https://github.com/<your_github_name>/doris.git
```
Note: Please replace your GitHub name with your yourgithubname.
When clone is completed, origin defaults to the remote fork address on github.
-#### (2) Add apache/incubator-doris to the remote branch upstream of the local
warehouse:
+#### (2) Add apache/doris to the remote branch upstream of the local warehouse:
```
-cd doris
+cd doris
git remote add upstream https://github.com/apache/doris.git
```
@@ -109,7 +109,7 @@ For how to write Commit Message, here are some Tips:
For more details, see <https://chris.beams.io/posts/git-commit>.
-
+
#### (4) Complete the creation
After successful creation, you can see that Doris project needs review, you
can wait for us to review and join, you can also contact us directly.
diff --git a/docs/en/community/release-and-verify/release-doris-connectors.md
b/docs/en/community/release-and-verify/release-doris-connectors.md
index 2ca227c22b..d039fc3bba 100644
--- a/docs/en/community/release-and-verify/release-doris-connectors.md
+++ b/docs/en/community/release-and-verify/release-doris-connectors.md
@@ -198,7 +198,7 @@ Keys to verify the Release Candidate:
https://downloads.apache.org/doris/KEYS
Look at here for how to verify this release candidate:
-http://doris.apache.org/community/release-and-verify/release-verify.html
+hhttps://doris.apache.org/zh-CN/community/release-and-verify/release-verify
The vote will be open for at least 72 hours or until necessary number of votes
are reached.
diff --git a/docs/en/community/release-and-verify/release-doris-core.md
b/docs/en/community/release-and-verify/release-doris-core.md
index ff07229188..2f53f7a9a7 100644
--- a/docs/en/community/release-and-verify/release-doris-core.md
+++ b/docs/en/community/release-and-verify/release-doris-core.md
@@ -26,7 +26,7 @@ under the License.
# Release Doris Core
-Doris Core refers to the content published in
https://github.com/apache/incubator-doris.
+Doris Core refers to the content published in https://github.com/apache/doris.
## Preparing for release
diff --git a/docs/en/community/release-and-verify/release-doris-manager.md
b/docs/en/community/release-and-verify/release-doris-manager.md
index 791ce32d38..3ae0452450 100644
--- a/docs/en/community/release-and-verify/release-doris-manager.md
+++ b/docs/en/community/release-and-verify/release-doris-manager.md
@@ -28,7 +28,7 @@ under the License.
Its codebase is separate from the main Doris codebase at:
-- https://github.com/apache/incubator-doris-manager
+- https://github.com/apache/doris-manager
## ready to publish
diff --git a/docs/en/community/subscribe-mail-list.md
b/docs/en/community/subscribe-mail-list.md
index d8067d1345..7f3a08ba77 100644
--- a/docs/en/community/subscribe-mail-list.md
+++ b/docs/en/community/subscribe-mail-list.md
@@ -26,7 +26,7 @@ under the License.
# Subscribe Mailing Lists
-Mail List is the most recognized form of communication in Apache community.
Generally speaking, open source community questions and answers, technical
discussions, transaction decisions are carried through mailing lists. The
asynchronous and broadcasting features of mailing lists are also very suitable
for communication in open source communities. So how do you subscribe to Apache
Doris (incubating) mailing lists? It mainly includes the following five steps.
+Mail List is the most recognized form of communication in Apache community.
Generally speaking, open source community questions and answers, technical
discussions, transaction decisions are carried through mailing lists. The
asynchronous and broadcasting features of mailing lists are also very suitable
for communication in open source communities. So how do you subscribe to Apache
Doris mailing lists? It mainly includes the following five steps.
## 1. Send Subscription Mail
diff --git a/docs/en/community/team.md b/docs/en/community/team.md
index 91ce51aec7..27d8901d42 100644
--- a/docs/en/community/team.md
+++ b/docs/en/community/team.md
@@ -43,7 +43,7 @@ We'd like to thank the following committers to the Apache
Doris project who have
| [lingmiao](https://people.apache.org/committer-index.html#lingmiao) |
EmmyMiao87 | Ling Miao |
| [wenming](https://people.apache.org/committer-index.html#wenming) | moonming
| Ming Wen |
| [morningman](https://people.apache.org/committer-index.html#morningman) |
morningman | Mingyu Chen |
-| [maruyue](https://people.apache.org/committer-index.html#maruyue) |
| Ruyue Ma |
+| [maruyue](https://people.apache.org/committer-index.html#maruyue) | maruyue
| Ruyue Ma |
| [ningjiang](https://people.apache.org/committer-index.html#ningjiang) |
WillemJiang | Willem Ning Jiang |
| [yangzhg](https://people.apache.org/committer-index.html#yangzhg) | yangzhg
| Zhengguo Yang |
| [weizuo](https://people.apache.org/committer-index.html#weizuo) | weizuo93
| Zuo Wei |
diff --git a/docs/zh-CN/community/design/grouping_sets_design.md
b/docs/zh-CN/community/design/grouping_sets_design.md
index 3fb5134b2f..0c19094cff 100644
--- a/docs/zh-CN/community/design/grouping_sets_design.md
+++ b/docs/zh-CN/community/design/grouping_sets_design.md
@@ -136,7 +136,7 @@ GROUPING SETS (
当我们没有统计某一列时，它的值显示为 NULL，这也可能是列本身就有 NULL 值，这就需要一种方法区分是没有统计还是值本来就是 NULL。为此引入
GROUPING 和 GROUPING_ID 函数。
GROUPING(column:Column) 函数用于区分分组后的单个列是普通列和聚合列。如果是聚合列，则返回1，反之，则是0. GROUPING()
只能有一个参数列。
-GROUPING_ID(column1, column2) 则根据指定的column 顺序，否则根据聚合的时候给的集合的元素顺序，计算出一个列列表的
bitmap 值，一个列如果是聚合列为1，否则为0. GROUPING_ID()函数返回位向量的十进制值。
+GROUPING_ID(column1, column2) 则根据指定的column 顺序，否则根据聚合的时候给的集合的元素顺序，计算出一个列列表的
bitmap 值，一个列如果是聚合列为0，否则为1. GROUPING_ID()函数返回位向量的十进制值。
比如 [0 1 0] ->2 从下列第三个查询可以看到这种对应关系
例如，对于下面的表：
diff --git a/docs/zh-CN/community/developer-guide/be-vscode-dev.md
b/docs/zh-CN/community/developer-guide/be-vscode-dev.md
index 763c64a3f6..bd2134f5f1 100644
--- a/docs/zh-CN/community/developer-guide/be-vscode-dev.md
+++ b/docs/zh-CN/community/developer-guide/be-vscode-dev.md
@@ -1,12 +1,8 @@
---
-{
- "title": "Doris BE开发调试环境 -- vscode",
- "language": "zh-CN"
-}
-
+{ 'title': 'Doris BE开发调试环境 -- vscode', 'language': 'zh-CN' }
---
-<!--
+<!--
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
@@ -31,13 +27,13 @@ under the License.
**本教程是在 Ubuntu 20.04 下进行的**
-**文中的出现的BE二进制文件名称 `doris_be`，在之前的版本中为 `palo_be`。**
+**文中的出现的 BE 二进制文件名称 `doris_be`，在之前的版本中为 `palo_be`。**
1. 下载 doris 源代码
- 下载地址为：[apache/doris: Apache Doris
(github.com)](https://github.com/apache/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 环境变量
+2. 安装 GCC 8.3.1+，Oracle JDK 1.8+，Python 2.7+，确认 gcc, java, python 命令指向正确版本, 设置
JAVA_HOME 环境变量
3. 安装其他依赖包
@@ -45,7 +41,7 @@ under the License.
sudo apt install build-essential openjdk-8-jdk maven cmake byacc flex automake
libtool-bin bison binutils-dev libiberty-dev zip unzip libncurses5-dev curl git
ninja-build python brotli
sudo add-apt-repository ppa:ubuntu-toolchain-r/ppa
sudo apt update
-sudo apt install gcc-10 g++-10
+sudo apt install gcc-10 g++-10
sudo apt-get install autoconf automake libtool autopoint
```
@@ -62,7 +58,7 @@ sudo apt install -y openssl-devel
1. 下载源码
```
-git clone https://github.com/apache/doris.git
+git clone https://github.com/apache/doris.git
```
2. 编译第三方依赖包
@@ -72,7 +68,7 @@ git clone https://github.com/apache/doris.git
./build-thirdparty.sh
```
-3. 编译doris产品代码
+3. 编译 doris 产品代码
```
cd /home/workspace/doris
@@ -92,17 +88,17 @@ cd /home/workspace/doris
./build.sh --be --fe --clean#删除并同时编译be fe
```
-如果不出意外，应该会编译成功，最终的部署文件将产出到 /home/workspace/doris/output/ 目录下。如果还遇到其他问题，可以参照
doris 的安装文档 http://doris.apache.org。
+如果不出意外，应该会编译成功，最终的部署文件将产出到 /home/workspace/doris/output/ 目录下。如果还遇到其他问题，可以参照
doris 的安装文档 http://doris.apache.org。
## 部署调试
-1. 给be编译结果文件授权
+1. 给 be 编译结果文件授权
```
chmod /home/workspace/doris/output/be/lib/doris_be
```
-注意： /home/workspace/doris/output/be/lib/doris_be为be的执行文件。
+注意： /home/workspace/doris/output/be/lib/doris_be 为 be 的执行文件。
2. 创建数据存放目录
@@ -122,16 +118,16 @@ brpc_port = 8060
# use CIDR format, e.g. 10.10.10.0/
# Default value is empty.
priority_networks = 192.168.59.0/24 # data root path, separate by ';'
-storage_root_path = /soft/be/storage
+storage_root_path = /soft/be/storage
# sys_log_dir = ${PALO_HOME}/log
# sys_log_roll_mode = SIZE-MB-
# sys_log_roll_num =
# sys_log_verbose_modules =
# log_buffer_level = -
-# palo_cgroups
+# palo_cgroups
```
-需要创建一个文件夹，这是be数据存放的地方
+需要创建一个文件夹，这是 be 数据存放的地方
```
mkdir -p /soft/be/storage
@@ -176,9 +172,9 @@ mkdir -p /soft/be/storage
}
```
-其中，environment 定义了几个环境变量 DORIS_HOME UDF_RUNTIME_DIR LOG_DIR PID_DIR，这是
doris_be 运行时需要的环境变量，如果没有设置，启动会失败。
+其中，environment 定义了几个环境变量 DORIS_HOME UDF_RUNTIME_DIR LOG_DIR PID_DIR，这是
doris_be 运行时需要的环境变量，如果没有设置，启动会失败。
-**注意：如果希望是attach(附加进程）调试，配置代码如下：**
+**注意：如果希望是 attach(附加进程）调试，配置代码如下：**
```
{
@@ -204,7 +200,7 @@ mkdir -p /soft/be/storage
}
```
-配置中 **"request": "attach"， "processId":PID**，这两个配置是重点： 分别设置 gdb 的调试模式为
attach，附加进程的processId，否则会失败。如何查找进程id，可以在命令行中输入以下命令：
+配置中 **"request": "attach"， "processId":PID**，这两个配置是重点： 分别设置 gdb 的调试模式为
attach，附加进程的 processId，否则会失败。如何查找进程 id，可以在命令行中输入以下命令：
```
ps -ef | grep palo*
@@ -214,7 +210,7 @@ ps -ef | grep palo*
-其中的15200即为当前运行的 be 的进程 id.
+其中的 15200 即为当前运行的 be 的进程 id.
一个完整的 launch.json 的例子如下：
@@ -279,7 +275,6 @@ ps -ef | grep palo*
6. 点击调试即可
- 下面就可以开始你的 Doris DEBUG 之旅了
+ 下面就可以开始你的 Doris DEBUG 之旅了
-
diff --git a/docs/zh-CN/community/developer-guide/benchmark-tool.md
b/docs/zh-CN/community/developer-guide/benchmark-tool.md
index d6126c2920..8bb45332c7 100644
--- a/docs/zh-CN/community/developer-guide/benchmark-tool.md
+++ b/docs/zh-CN/community/developer-guide/benchmark-tool.md
@@ -33,7 +33,7 @@ under the License.
## 编译
-1.
确保环境已经能顺利编译Doris本体,可以参考[编译与部署](../../docs/install/source-install/compilation.md)。
+1. 确保环境已经能顺利编译Doris本体,可以参考[编译与部署](/docs/install/source-install/compilation)。
2. 运行目录下的`run-be-ut.sh`
diff --git a/docs/zh-CN/community/developer-guide/cpp-diagnostic-code.md
b/docs/zh-CN/community/developer-guide/cpp-diagnostic-code.md
index 66e8d40dd4..2b45a29449 100644
--- a/docs/zh-CN/community/developer-guide/cpp-diagnostic-code.md
+++ b/docs/zh-CN/community/developer-guide/cpp-diagnostic-code.md
@@ -26,7 +26,7 @@ under the License.
# C++ 代码分析
-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)
+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)
中已经内置，另外也可以自己安装或者编译。
### Clang-Tidy
diff --git a/docs/zh-CN/community/developer-guide/cpp-format-code.md
b/docs/zh-CN/community/developer-guide/cpp-format-code.md
index 77a19b0148..5a9a51d893 100644
--- a/docs/zh-CN/community/developer-guide/cpp-format-code.md
+++ b/docs/zh-CN/community/developer-guide/cpp-format-code.md
@@ -66,8 +66,8 @@ centos yum安装的clang-format版本过老，支持的StyleOption太少，建
LDB toolchain:
-如果使用[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
+如果使用 [LDB
toolchain](/docs/install/source-install/compilation-with-ldb-toolchain)，
+最新版本的 [LDB
toolchain](https://github.com/amosbird/ldb_toolchain_gen/releases)（>=
v0.11）已经包含了预编译的clang-format
13.0.1的二进制文件。
### clang-format插件
diff --git a/docs/zh-CN/community/developer-guide/docker-dev.md
b/docs/zh-CN/community/developer-guide/docker-dev.md
index f5f90ad84b..95991b2329 100644
--- a/docs/zh-CN/community/developer-guide/docker-dev.md
+++ b/docs/zh-CN/community/developer-guide/docker-dev.md
@@ -29,9 +29,9 @@ under the License.
## 相关详细文档导航
-- [使用 Docker 开发镜像编译](../../docs/install/source-install/compilation.md)
-- [部署](../../docs/install/install-deploy.md)
-- [VSCode Be 开发调试](./be-vscode-dev.md)
+- [使用 Docker 开发镜像编译](/docs/install/source-install/compilation)
+- [部署](/docs/install/install-deploy)
+- [VSCode Be 开发调试](./be-vscode-dev)
## 环境准备
@@ -90,7 +90,7 @@ docker build -t doris .
运行镜像
-此处按需注意 [挂载的问题](../../docs/install/source-install/compilation.md)
+此处按需注意 [挂载的问题](../../docs/install/source-install/compilation/)
> 见链接中：建议以挂载本地 Doris 源码目录的方式运行镜像 .....
@@ -112,7 +112,7 @@ plugins=(git zsh-autosuggestions zsh-syntax-highlighting)
```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
```
## 编译
diff --git a/docs/zh-CN/community/developer-guide/fe-idea-dev.md
b/docs/zh-CN/community/developer-guide/fe-idea-dev.md
index 4f10443c40..b4f032e12e 100644
--- a/docs/zh-CN/community/developer-guide/fe-idea-dev.md
+++ b/docs/zh-CN/community/developer-guide/fe-idea-dev.md
@@ -28,61 +28,47 @@ under the License.
## 1.环境准备
-从 https://github.com/apache/incubator-doris.git 下载源码到本地
-
-安装 JDK1.8+ ，使用 IntelliJ IDEA 打开 FE.
-
-### thrift
-
-如果仅进行fe开发而没有编译过thirdparty，则需要安装thrift，并将thrift 复制或者连接到
`thirdparty/installed/bin` 目录下
-
-安装 `thrift` 0.13.0 版本(注意：`Doris` 0.15 和最新的版本基于 `thrift` 0.13.0 构建,
之前的版本依然使用`thrift` 0.9.3 构建)
-
-#### Windows 下载
-
-1. 下载：`http://archive.apache.org/dist/thrift/0.13.0/thrift-0.13.0.exe`
-2. 拷贝：将文件拷贝至 `./thirdparty/installed/bin`
-
-#### MacOS 下载
-
-下载：`brew install thrift@0.13.0`
-
-注：macOS执行 `brew install thrift@0.13.0` 可能会报找不到版本的错误，解决方法如下，在终端执行：
-
-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`
-
-参考链接: `https://gist.github.com/tonydeng/02e571f273d6cce4230dc8d5f394493c`
-
-#### 建立软链接
-
-位于 Doris **根**目录下
-
-`mkdir -p ./thirdparty/installed/bin`
-
-ARM架构macOS
-
-`ln -s /opt/homebrew/Cellar/thrift@0.13.0/0.13.0/bin/thrift
./thirdparty/installed/bin/thrift`
-
-Intel架构macOS
-
-`ln -s /usr/local/Cellar/thrift@0.13.0/0.13.0/bin/thrift
./thirdparty/installed/bin/thrift`
-
-### 自动生成代码：
-
-如果是Mac 或者 Linux 环境 可以通过 如下命令生成
-
-```
-cd fe
-mvn generate-sources
-```
-
-如果出现错误，则执行：
-
-```
-cd fe && mvn clean install -DskipTests
-```
+JDK1.8+, IntelliJ IDEA
+
+1. 从 https://github.com/apache/doris.git 下载源码到本地
+
+2. 使用IntelliJ IDEA 打开代码根目录
+
+3. 如果仅进行fe开发而没有编译过thirdparty，则需要安装thrift，并将thrift 复制或者连接到
`thirdparty/installed/bin` 目录下
+
+ 安装 `thrift` 0.13.0 版本(注意：`Doris` 0.15 和最新的版本基于 `thrift` 0.13.0 构建,
之前的版本依然使用`thrift` 0.9.3 构建)
+
+ Windows:
+ 1.
下载：`http://archive.apache.org/dist/thrift/0.13.0/thrift-0.13.0.exe`
+ 2. 拷贝：将文件拷贝至 `./thirdparty/installed/bin`
+
+ MacOS:
+ 1. 下载：`brew install thrift@0.13.0`
+ 2. 建立软链接：
+ `mkdir -p ./thirdparty/installed/bin`
+ # ARM架构macOS
+ `ln -s /opt/homebrew/Cellar/thrift@0.13.0/0.13.0/bin/thrift
./thirdparty/installed/bin/thrift`
+ # Intel架构macOS
+ `ln -s /usr/local/Cellar/thrift@0.13.0/0.13.0/bin/thrift
./thirdparty/installed/bin/thrift`
+
+ 注：MacOS执行 `brew install thrift@0.13.0` 可能会报找不到版本的错误，解决方法如下，在终端执行：
+ 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`
+ 参考链接:
`https://gist.github.com/tonydeng/02e571f273d6cce4230dc8d5f394493c`
+
+4. 如果是Mac 或者 Linux 环境 可以通过 如下命令自动生成代码：
+
+ ```
+ cd fe
+ mvn generate-sources
+ ```
+
+ 如果出现错误，则执行：
+
+ ```
+ cd fe && mvn clean install -DskipTests
+ ```
或者通过图形界面运行 maven 命令生成
@@ -90,28 +76,8 @@ cd fe && mvn clean install -DskipTests
如果使用windows环境可能会有make命令和sh脚本无法执行的情况 可以通过拷贝linux上的
`fe/fe-core/target/generated-sources` 目录拷贝到相应的目录的方式实现，也可以通过docker
镜像挂载本地目录之后，在docker 内部生成自动生成代码，可以参照编译一节
-#### arm mac compile failed
-
-如果在m1 mac上进行自动生成代码会出现如下错误
-
-```
-[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.
-```
-
-ptotobuf3.14.0和protoc-gen-grpc-java1.30.0没有aarch64的版本，根据[grpc社区issue](https://github.com/grpc/grpc-java/issues/7690)的建议下载x86版本并使用rosetta转译
-
-1. 打开`doris/fe/fe-core/pom.xml`
-2.
将`<protocArtifact>com.google.protobuf:protoc:${protobuf.version}</protocArtifact>`修改成`<protocArtifact>com.google.protobuf:protoc:3.14.0:exe:osx-x86_64</protocArtifact>`
-3.
将`<pluginArtifact>io.grpc:protoc-gen-grpc-java:${grpc.version}</pluginArtifact>`修改成`<pluginArtifact>io.grpc:protoc-gen-grpc-java:1.30.0:exe:osx-x86_64</pluginArtifact>`
-4. 打开终端输入`softwareupdate --install-rosetta`
-
-### help文档
-
-如果还未生成过help文档，需要跳转到docs目录，执行`sh build_help_zip.sh`，
-
-然后将build中的help-resource.zip拷贝到fe/fe-core/target/classes中
+5. 如果还未生成过help文档，需要跳转到docs目录，执行`sh build_help_zip.sh`，
+ 然后将build中的help-resource.zip拷贝到fe/fe-core/target/classes中
## 2.调试
@@ -125,9 +91,82 @@
ptotobuf3.14.0和protoc-gen-grpc-java1.30.0没有aarch64的版本，根据[grpc
## 3.配置conf/fe.conf
-配置在 `conf/fe.conf`，你可以根据自己的需要进行修改
+下面是我自己的配置，你可以根据自己的需要进行修改(注意：如果使用`Mac`开发，由于`docker for
Mac`不支持`Host`模式，需要使用`-p`方式暴露`be`端口，同时`fe.conf`的`priority_networks`配置为容器内可访问的Ip，例如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
+
+```
+
-(注意：如果使用`Mac`开发，由于`docker for
Mac`不支持`Host`模式，需要使用`-p`方式暴露`be`端口，同时`fe.conf`的`priority_networks`配置为容器内可访问的Ip，例如WIFI的Ip)
## 4.设置环境变量
diff --git a/docs/zh-CN/community/developer-guide/fe-vscode-dev.md
b/docs/zh-CN/community/developer-guide/fe-vscode-dev.md
index b5700956dd..727063747f 100644
--- a/docs/zh-CN/community/developer-guide/fe-vscode-dev.md
+++ b/docs/zh-CN/community/developer-guide/fe-vscode-dev.md
@@ -37,7 +37,7 @@ under the License.
## 下载代码编译
-1. 从 https://github.com/apache/incubator-doris.git 下载源码到本地
+1. 从 https://github.com/apache/doris.git 下载源码到本地
2. 使用 VSCode 打开代码 `/fe` 目录
@@ -72,7 +72,7 @@ example:
## 编译
其他文章已经介绍的比较清楚了：
-* [使用 LDB toolchain
编译](../../docs/install/source-install/compilation-with-ldb-toolchain.md)
+* [使用 LDB toolchain
编译](/docs/install/source-install/compilation-with-ldb-toolchain)
* ......
为了进行调试，需要在 fe 启动时，加上调试的参数，比如
`-agentlib:jdwp=transport=dt_socket,server=y,suspend=n,address=5005` 。
diff --git a/docs/zh-CN/community/developer-guide/regression-testing.md
b/docs/zh-CN/community/developer-guide/regression-testing.md
index d92b25c148..984115d7a3 100644
--- a/docs/zh-CN/community/developer-guide/regression-testing.md
+++ b/docs/zh-CN/community/developer-guide/regression-testing.md
@@ -136,7 +136,7 @@ sql action用于提交sql并获取结果，如果查询失败则会抛出异常
参数如下
- String sql: 输入的sql字符串
-- return List<List<Object>>: 查询结果，如果是DDL/DML，则返回一行一列，唯一的值是updateRowCount
+- `return List<List<Object>>`: 查询结果，如果是DDL/DML，则返回一行一列，唯一的值是updateRowCount
下面的样例代码存放于`${DORIS_HOME}/regression-test/suites/demo/sql_action.groovy`:
```groovy
@@ -269,13 +269,13 @@ test action可以使用更复杂的校验规则来测试，比如验证行数、
可用参数
- String sql: 输入的sql字符串
-- List<List<Object>> result: 提供一个List对象，用于比较真实查询结果与List对象是否相等
-- Iterator<Object> resultIterator: 提供一个Iterator对象，用于比较真实查询结果与Iterator是否相等
+- `List<List<Object>> result`: 提供一个List对象，用于比较真实查询结果与List对象是否相等
+- `Iterator<Object> resultIterator`: 提供一个Iterator对象，用于比较真实查询结果与Iterator是否相等
- String resultFile:
提供一个文件Uri(可以是本地文件相对路径，或http(s)路径)，用于比较真实查询结果与http响应流是否相等，格式与.out文件格式类似，但没有块头和注释
- String exception: 校验抛出的异常是否包含某些字符串
- long rowNum: 验证结果行数
- long time: 验证执行时间是否小于这个值，单位是毫秒
-- Closure<List<List<Object>>, Throwable, Long, Long> check:
自定义回调校验，可传入结果、异常、时间。存在回调函数时，其他校验方式会失效。
+- `Closure<List<List<Object>>, Throwable, Long, Long> check`:
自定义回调校验，可传入结果、异常、时间。存在回调函数时，其他校验方式会失效。
下面的样例代码存放于`${DORIS_HOME}/regression-test/suites/demo/test_action.groovy`:
```groovy
@@ -373,8 +373,8 @@ explain action用来校验explain返回的字符串是否包含某些字符串
- String sql: 查询的sql，需要去掉sql中的explain
- String contains: 校验explain是否包含某些字符串，可多次调用校验同时多个结果
- String notContains: 校验explain是否不含某些字符串，可多次调用校验同时多个结果
-- Closure<String> check: 自定义校验回调函数，可以获取返回的字符串，存在校验函数时，其他校验方式会失效
-- Closure<String, Throwable, Long, Long> check: 自定义校验回调函数，可以额外获取异常和时间
+- `Closure<String> check`: 自定义校验回调函数，可以获取返回的字符串，存在校验函数时，其他校验方式会失效
+- `Closure<String, Throwable, Long, Long> check`: 自定义校验回调函数，可以额外获取异常和时间
下面的样例代码存放于`${DORIS_HOME}/regression-test/suites/demo/explain_action.groovy`:
```groovy
@@ -419,12 +419,12 @@ streamLoad action用于导入数据
- String db: db，默认值为regression-conf.groovy中的defaultDb
- String table: 表名
- String file: 要导入的文件路径，可以写data目录下的相对路径，或者写http url来导入网络文件
-- Iterator<List<Object>> inputIterator: 要导入的迭代器
+- `Iterator<List<Object>> inputIterator`: 要导入的迭代器
- String inputText: 要导入的文本, 较为少用
- InputStream inputStream: 要导入的字节流，较为少用
- long time: 验证执行时间是否小于这个值，单位是毫秒
- void set(String key, String value): 设置stream
load的http请求的header，如label、columnSeparator
-- Closure<String, Throwable, Long, Long> check:
自定义校验回调函数，可以获取返回结果、异常和超时时间。当存在回调函数时，其他校验项会失效。
+- `Closure<String, Throwable, Long, Long> check`:
自定义校验回调函数，可以获取返回结果、异常和超时时间。当存在回调函数时，其他校验项会失效。
下面的样例代码存放于`${DORIS_HOME}/regression-test/suites/demo/streamLoad_action.groovy`:
```groovy
diff --git a/docs/zh-CN/community/how-to-contribute/contribute-doc.md
b/docs/zh-CN/community/how-to-contribute/contribute-doc.md
new file mode 100644
index 0000000000..098e18f0bc
--- /dev/null
+++ b/docs/zh-CN/community/how-to-contribute/contribute-doc.md
@@ -0,0 +1,312 @@
+---
+{
+ "title": "文档贡献",
+ "language": "zh-CN"
+}
+---
+
+<!--
+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 做贡献](./)
+
+[代码提交指南](./pull-request)
+
+历史版本的文档，直接在 [apache/doris-website](https://github.com/apache/doris-website)
上提交 PR 即可，如果是最新版本的，需要在
[apache/doris-website](https://github.com/apache/doris-website) 和
[apache/doris](https://github.com/apache/doris) 代码库上同时提交修改。
+
+下面介绍 Doris Website站点的目录结构，以方便用户修改提交文档
+
+## Doris Website 目录结构
+
+```
+.
+├── README.md
+├── babel.config.js
+├── blog
+│ ├── 1.1 Release.md
+│ ├── Annoucing.md
+│ ├── jd.md
+│ ├── meituan.md
+│ ├── release-note-0.15.0.md
+│ ├── release-note-1.0.0.md
+│ └── xiaomi.md
+├── build.sh
+├── community
+│ ├── design
+│ │ ├── Flink-doris-connector-Design.md
+│ │ ├── doris_storage_optimization.md
+│ │ ├── grouping_sets_design.md
+│ │ └── metadata-design.md
+│ ├── ......
+├── docs
+│ ├── admin-manual
+│ │ ├── cluster-management
+│ │ ├── config
+│ │ ├── data-admin
+│ │ ├── http-actions
+│ │ ├── maint-monitor
+│ │ ├── multi-tenant.md
+│ │ ├── optimization.md
+│ │ ├── privilege-ldap
+│ │ ├── query-profile.md
+│ │ └── sql-interception.md
+│ ├── ......
+├── docusaurus.config.js
+├── i18n
+│ └── zh-CN
+│ ├── code.json
+│ ├── docusaurus-plugin-content-blog
+│ ├── docusaurus-plugin-content-docs
+│ ├── docusaurus-plugin-content-docs-community
+│ └── docusaurus-theme-classic
+├── package.json
+├── sidebars.json
+├── sidebarsCommunity.json
+├── src
+│ ├── components
+│ │ ├── Icons
+│ │ ├── More
+│ │ ├── PageBanner
+│ │ └── PageColumn
+│ ├── ......
+├── static
+│ ├── images
+│ │ ├── Bloom_filter.svg.png
+│ │ ├── .....
+│ └── js
+│ └── redirect.js
+├── tree.out
+├── tsconfig.json
+├── versioned_docs
+│ ├── version-0.15
+│ │ ├── administrator-guide
+│ │ ├── best-practices
+│ │ ├── extending-doris
+│ │ ├── getting-started
+│ │ ├── installing
+│ │ ├── internal
+│ │ ├── sql-reference
+│ │ └── sql-reference-v2
+│ └── version-1.0
+│ ├── administrator-guide
+│ ├── benchmark
+│ ├── extending-doris
+│ ├── faq
+│ ├── getting-started
+│ ├── installing
+│ ├── internal
+│ ├── sql-reference
+│ └── sql-reference-v2
+├── versioned_sidebars
+│ ├── version-0.15-sidebars.json
+│ └── version-1.0-sidebars.json
+├── versions.json
+
+```
+
+目录结构说明：
+
+1. 博客目录
+
+ - 英文博客目录在根目录下的blog下面，所有博客的英文文件放到这个目录下
+ - 中文博客的目录在 `i18n/zh-CN/docusaurus-plugin-content-blog` 目录下，所有中文博客文件放到这个下面
+ - 中英文博客的文件名称要一致
+
+2. 文档内容目录
+
+ - 最新版本的英文文档内容在根目录下的docs下面
+
+ - 英文文档的版本在根目录下的 `versioned_docs/` 下面
+
+ - 这个目录只放历史版本的文档
+
+ ```
+ .
+ ├── version-0.15
+ │ ├── administrator-guide
+ │ ├── best-practices
+ │ ├── extending-doris
+ │ ├── getting-started
+ │ ├── installing
+ │ ├── internal
+ │ ├── sql-reference
+ │ └── sql-reference-v2
+ └── version-1.0
+ ├── administrator-guide
+ ├── benchmark
+ ├── extending-doris
+ ├── faq
+ ├── getting-started
+ ├── installing
+ ├── internal
+ ├── sql-reference
+ └── sql-reference-v2
+ ```
+
+ - 英文文档的版本控制在根目录下的 `versioned_sidebars` 下面
+
+ ```
+ .
+ ├── version-0.15-sidebars.json
+ └── version-1.0-sidebars.json
+ ```
+
+ 这里的 json 文件按照对应版本的目录结构进行编写
+
+ - 中文文档在 `i18n/zh-CN/docusaurus-plugin-content-docs`
+
+ - 在这个下面对应不同的版本目录及版本对应的 json 文件 ，如下效果
+
+ current是当前最新版本的文档，示例中对应的是 1.1 版本，修改的时候，根据要修改的文档版本，在对应目录下找到相应的文件修改，提交即可。
+
+ ```
+ .
+ ├── current
+ │ ├── admin-manual
+ │ ├── advanced
+ │ ├── benchmark
+ │ ├── data-operate
+ │ ├── data-table
+ │ ├── ecosystem
+ │ ├── faq
+ │ ├── get-starting
+ │ ├── install
+ │ ├── sql-manual
+ │ └── summary
+ ├── current.json
+ ├── version-0.15
+ │ ├── administrator-guide
+ │ ├── best-practices
+ │ ├── extending-doris
+ │ ├── getting-started
+ │ ├── installing
+ │ ├── internal
+ │ ├── sql-reference
+ │ └── sql-reference-v2
+ ├── version-0.15.json
+ ├── version-1.0
+ │ ├── administrator-guide
+ │ ├── benchmark
+ │ ├── extending-doris
+ │ ├── faq
+ │ ├── getting-started
+ │ ├── installing
+ │ ├── internal
+ │ ├── sql-reference
+ │ └── sql-reference-v2
+ └── version-1.0.json
+ ```
+
+ - Version Json 文件
+
+ Current.json 对应的是最新版本文档的中文翻译内容，例如：
+
+ ```
+ {
+ "version.label": {
+ "message": "1.1",
+ "description": "The label for version current"
+ },
+ "sidebar.docs.category.Getting Started": {
+ "message": "快速开始",
+ "description": "The label for category Getting Started in sidebar
docs"
+ }
+ .....
+ }
+ ```
+
+ 这里的 `sidebar.docs.category.Getting Started` 和根目录下的 `sidebars.json` 里的
`label` 对应
+
+ 例如刚才这个 `sidebar.docs.category.Getting Started` ，是由 `sidebar` 前缀和
`sidebars.json` 里面的结构对应的
+
+ 首先是 `sidebar + "." + docs + ".'" + [ type ] + [ label ] ` 组成.
+
+ ```json
+ {
+ "docs": [
+ {
+ "type": "category",
+ "label": "Getting Started",
+ "items": [
+ "get-starting/get-starting"
+ ]
+ },
+ {
+ "type": "category",
+ "label": "Doris Introduction",
+ "items": [
+ "summary/basic-summary"
+ ]
+ }
+ .....
+ }
+ ```
+
+ - 在中文的 version json 文件中支持 label 的翻译，不需要描述文档层级关系，文档层级关系是在 `sidebar.json`
文件里描述的
+
+ - 所有的文档必须有英文的，中文才能显示，如果英文没写，可以创建一个空文件，不然中文文档也显示不出来，这个适用于所有博客、文档、社区内容
+
+3. 社区文档
+
+ 这块的文档不区分版本，是通用的
+
+ - 英文文档在根目录下的 `community/` 目录下面。
+
+ - 中文文档在 `i18n/zh-CN/docusaurus-plugin-content-docs-community/` 目录下面。
+
+ - 社区文档的目录结构控制在根目录下的 `sidebarsCommunity.json` 文件中，
+
+ - 社区文档目录结构对应的中文翻译在
`i18n/zh-CN/docusaurus-plugin-content-docs-community/current.json` 文件中
+
+ ```json
+ {
+ "version.label": {
+ "message": "Next",
+ "description": "The label for version current"
+ },
+ "sidebar.community.category.How to Contribute": {
+ "message": "贡献指南",
+ "description": "The label for category How to Contribute in sidebar
community"
+ },
+ "sidebar.community.category.Release Process & Verification": {
+ "message": "版本发布与校验",
+ "description": "The label for category Release Process & Verification
in sidebar community"
+ },
+ "sidebar.community.category.Design Documents": {
+ "message": "设计文档",
+ "description": "The label for category Design Documents in sidebar
community"
+ },
+ "sidebar.community.category.Developer Guide": {
+ "message": "开发者手册",
+ "description": "The label for category Developer Guide in sidebar
community"
+ }
+ }
+ ```
+
+4. 图片
+
+ 所有图片都在 `static/images `目录下面
\ No newline at end of file
diff --git a/docs/zh-CN/community/how-to-contribute/contributor-guide.md
b/docs/zh-CN/community/how-to-contribute/contributor-guide.md
index b8f3fadce1..5ef8b86fb2 100644
--- a/docs/zh-CN/community/how-to-contribute/contributor-guide.md
+++ b/docs/zh-CN/community/how-to-contribute/contributor-guide.md
@@ -42,7 +42,7 @@ commits邮件非常重要，因为所有的GitHub Issue，PR提交都会发往
### 关联你的 ASF 账号与 Github 账号
我们用GitHub来管理我们的Issue以及用户贡献。
-所以你需要把你的ASF账号与GitHub账号进行关联来获得[Doris仓库](https://github.com/apache/incubator-doris)的写入权限。
+所以你需要把你的ASF账号与GitHub账号进行关联来获得[Doris仓库](https://github.com/apache/doris)的写入权限。
通过在[Gitbox](https://gitbox.apache.org/setup/)完成操作后，你就可以对GitHub仓库中的Issue，PR进行管理。
## Code Review指南
diff --git a/docs/zh-CN/community/how-to-contribute/how-to-be-a-committer.md
b/docs/zh-CN/community/how-to-contribute/how-to-be-a-committer.md
index 5ff3a64587..acfe9de659 100644
--- a/docs/zh-CN/community/how-to-contribute/how-to-be-a-committer.md
+++ b/docs/zh-CN/community/how-to-contribute/how-to-be-a-committer.md
@@ -28,7 +28,7 @@ under the License.
在 Apache 项目中，开发者有三种角色：
-1. Contributor：当开发者的代码正式合入代码后，该开发者自动成为该项目的 Contributor。
+1. Contributor：当开发者的代码正式合入代码后，该开发这自动成为该项目的 Contributor。
2. Committer：Committer 对代码库有合入权限。Committer 一般由 PMC（项目管理委员会）经过投票推举产生。
3. PMC Member：项目管理委员会成员。对项目的决策（如版本发布等）有投票权。一般由 PMC（项目管理委员会）经过投票推举产生。
diff --git a/docs/zh-CN/community/how-to-contribute/how-to-contribute.md
b/docs/zh-CN/community/how-to-contribute/how-to-contribute.md
index 7dc2418b3f..e482cb4055 100644
--- a/docs/zh-CN/community/how-to-contribute/how-to-contribute.md
+++ b/docs/zh-CN/community/how-to-contribute/how-to-contribute.md
@@ -28,7 +28,7 @@ under the License.
非常感谢您对 Doris 项目感兴趣，我们非常欢迎您对 Doris 项目的各种建议、意见（包括批评）、评论和贡献。
-您对 Doris 的各种建议、意见、评论可以直接通过 GitHub 的
[Issues](https://github.com/apache/incubator-doris/issues/new/choose) 提出。
+您对 Doris 的各种建议、意见、评论可以直接通过 GitHub 的
[Issues](https://github.com/apache/doris/issues/new/choose) 提出。
参与 Doris
项目并为其作出贡献的方法有很多：代码实现、测试编写、流程工具改进、文档完善等等。任何贡献我们都会非常欢迎，并将您加入贡献者列表，进一步，有了足够的贡献后，您还可以有机会成为
Apache 的 Committer，拥有 Apache 邮箱，并被收录到 [Apache Committer
列表中](http://people.apache.org/committer-index.html)。
@@ -38,7 +38,7 @@ under the License.
初次来到 Doris 社区，您可以：
-* 关注 Doris [Github 代码库](https://github.com/apache/incubator-doris)
+* 关注 Doris [Github 代码库](https://github.com/apache/doris)
* 订阅我们的 [邮件列表](../subscribe-mail-list.md)；
* 加入 Doris 微信群(加微信号：morningman-cmy, 备注：加入Doris群) 随时提问；
* 加入
[Slack](https://join.slack.com/t/apachedoriscommunity/shared_invite/zt-11jb8gesh-7IukzSrdea6mqoG0HB4gZg);
@@ -47,17 +47,17 @@ under the License.
## Doris 的代码和文档
-正如您在 [GitHub](https://github.com/apache/incubator-doris) 上看到的，Apache Doris
(incubating) 的代码库主要包括三部分：Frontend (FE), Backend (BE) 和 Broker (为了支持 HDFS
等外部存储系统上的文件读取)。文档主要是 Doris 网站和 GitHub 上的 wiki，还有运行 Doris
的时候的在线帮助手册。这些组件的详细情况参见下表：
+正如您在 [GitHub](https://github.com/apache/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 |
-| [Manager](https://github.com/apache/incubator-doris-manager) | Doris Manager
| Java |
-| [Flink-Connector](https://github.com/apache/incubator-doris-flink-connector)
| Doris Flink Connector | Java |
-| [Spark-Connector](https://github.com/apache/incubator-doris-spark-connector)
| Doris Spark Connector | Java |
+| [Frontend daemon (FE)](https://github.com/apache/doris)| 由“查询协调器”和“元数据管理器”组成
| Java|
+| [Backend daemon (BE)](https://github.com/apache/doris) | 负责存储数据和执行查询片段 | C++|
+| [Broker](https://github.com/apache/doris) | 读取 HDFS 数据到 Doris | Java |
+| [Website](https://github.com/apache/doris-website) | Doris 网站 | Markdown |
+| [Manager](https://github.com/apache/doris-manager) | Doris Manager | Java |
+| [Flink-Connector](https://github.com/apache/doris-flink-connector) | Doris
Flink Connector | Java |
+| [Spark-Connector](https://github.com/apache/doris-spark-connector) | Doris
Spark Connector | Java |
| Doris 运行时 help 文档 | 运行 Doris 的时候的在线帮助手册 | Markdown |
## 改进文档
@@ -68,17 +68,17 @@ under the License.
如果您对改进文档的质量感兴趣，不论是修订一个页面的地址、更正一个链接、以及写一篇更优秀的入门文档，我们都非常欢迎！
-我们的文档大多数是使用 markdown 格式编写的，您可以直接通过在
[GitHub](https://github.com/apache/incubator-doris) 中的 `docs/`
中修改并提交文档变更。如果提交代码变更，可以参阅 [Pull Request](./pull-request.md)。
+我们的文档大多数是使用 markdown 格式编写的，您可以直接通过在 [GitHub](https://github.com/apache/doris)
中的 `docs/` 中修改并提交文档变更。如果提交代码变更，可以参阅 [Pull Request](./pull-request.md)。
## 如果发现了一个 Bug 或问题
-如果发现了一个 Bug 或问题，您可以直接通过 GitHub 的
[Issues](https://github.com/apache/incubator-doris/issues/new/choose) 提一个新的
Issue，我们会有人定期处理。
+如果发现了一个 Bug 或问题，您可以直接通过 GitHub 的
[Issues](https://github.com/apache/doris/issues/new/choose) 提一个新的
Issue，我们会有人定期处理。
您也可以通过阅读分析代码自己修复（当然在这之前最好能和我们交流下，或许已经有人在修复同样的问题了），然后提交一个 [Pull
Request](./pull-request.md)。
## 修改代码和提交PR（Pull Request）
-您可以下载代码，编译安装，部署运行试一试（可以参考[编译文档](../../install/source-install/compilation.md)），看看是否与您预想的一样工作。如果有问题，您可以直接联系我们，提
Issue 或者通过阅读和分析源代码自己修复。
+您可以下载代码，编译安装，部署运行试一试（可以参考[编译文档](/docs/install/source-install/compilation.md)，看看是否与您预想的一样工作。如果有问题，您可以直接联系我们，提
Issue 或者通过阅读和分析源代码自己修复。
无论是修复 Bug 还是增加 Feature，我们都非常欢迎。如果您希望给 Doris 提交代码，您需要从 GitHub 上 fork
代码库至您的项目空间下，为您提交的代码创建一个新的分支，添加源项目为upstream，并提交PR。
提交PR的方式可以参考文档 [Pull Request](./pull-request.md)。
diff --git a/docs/zh-CN/community/how-to-contribute/pull-request.md
b/docs/zh-CN/community/how-to-contribute/pull-request.md
index 424527c293..d8c0e08407 100644
--- a/docs/zh-CN/community/how-to-contribute/pull-request.md
+++ b/docs/zh-CN/community/how-to-contribute/pull-request.md
@@ -49,7 +49,7 @@ clone 完成后，origin 会默认指向 github 上的远程 fork 地址。
#### （2）将 apache/doris 添加为本地仓库的远程分支 upstream：
```
-cd doris
+cd doris
git remote add upstream https://github.com/apache/doris.git
```
@@ -109,7 +109,7 @@ git push origin <your_branch_name>
更详细的内容请参考 <https://chris.beams.io/posts/git-commit>
-
+
#### （4）完成创建
创建成功后，您可以看到 Doris 项目需要 review，您可以等待我们 review 和合入，您也可以直接联系我们。
diff --git a/docs/zh-CN/community/release-and-verify/release-doris-core.md
b/docs/zh-CN/community/release-and-verify/release-doris-core.md
index a08fc0dc4d..d6b8914bf8 100644
--- a/docs/zh-CN/community/release-and-verify/release-doris-core.md
+++ b/docs/zh-CN/community/release-and-verify/release-doris-core.md
@@ -26,7 +26,7 @@ under the License.
# 发布 Doris Core
-Doris Core 指发布 https://github.com/apachedoris 中的内容。
+Doris Core 指发布 https://github.com/apache/doris 中的内容。
## 准备发布
diff --git a/docs/zh-CN/community/team.md b/docs/zh-CN/community/team.md
index 4b101b1521..751bce0a5a 100644
--- a/docs/zh-CN/community/team.md
+++ b/docs/zh-CN/community/team.md
@@ -43,7 +43,7 @@ under the License.
| [lingmiao](https://people.apache.org/committer-index.html#lingmiao) |
EmmyMiao87 | Ling Miao |
| [wenming](https://people.apache.org/committer-index.html#wenming) | moonming
| Ming Wen |
| [morningman](https://people.apache.org/committer-index.html#morningman) |
morningman | Mingyu Chen |
-| [maruyue](https://people.apache.org/committer-index.html#maruyue) |
| Ruyue Ma |
+| [maruyue](https://people.apache.org/committer-index.html#maruyue) | maruyue
| Ruyue Ma |
| [ningjiang](https://people.apache.org/committer-index.html#ningjiang) |
WillemJiang | Willem Ning Jiang |
| [yangzhg](https://people.apache.org/committer-index.html#yangzhg) | yangzhg
| Zhengguo Yang |
| [weizuo](https://people.apache.org/committer-index.html#weizuo) | weizuo93
| Zuo Wei |
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscr...@doris.apache.org
For additional commands, e-mail: commits-h...@doris.apache.org
