feat:docs (apache#1461)

Signed-off-by: zenghua <[email protected]> Co-authored-by: liyang <[email protected]> Co-authored-by: Jeffrey <[email protected]> Co-authored-by: wudi <[email protected]> Co-authored-by: xzj7019 <[email protected]> Co-authored-by: Pxl <[email protected]> Co-authored-by: Mingyu Chen (Rayner) <[email protected]> Co-authored-by: wangbo <[email protected]> Co-authored-by: smiletan <[email protected]> Co-authored-by: Kaijie Chen <[email protected]> Co-authored-by: zhangstar333 <[email protected]> Co-authored-by: KassieZ <[email protected]> Co-authored-by: wangtianyi2004 <[email protected]> Co-authored-by: Mingxi <[email protected]> Co-authored-by: Ruffian Jiang <[email protected]> Co-authored-by: zclllhhjj <[email protected]> Co-authored-by: 小可耐 <[email protected]> Co-authored-by: Ceng <[email protected]> Co-authored-by: lihangyu <[email protected]> Co-authored-by: zhangstar333 <[email protected]> Co-authored-by: hui lai <[email protected]> Co-authored-by: catpineapple <[email protected]> Co-authored-by: walter <[email protected]> Co-authored-by: Xujian Duan <[email protected]> Co-authored-by: Vallish Pai <[email protected]> Co-authored-by: LiBinfeng <[email protected]>
KassieZ · Dec 5, 2024 · 74de2f7 · 74de2f7
1 parent d25cd71
commit 74de2f7
Show file tree

Hide file tree

Showing 218 changed files with 12,594 additions and 8,617 deletions.
diff --git a/.asf-site.yaml b/.asf-site.yaml
@@ -16,4 +16,4 @@
 #
 
 publish:
-  whoami: asf-site
+  whoami: asf-site
diff --git a/.env b/.env
@@ -0,0 +1 @@
+TEST_ENV_URL="http://localhost:3000"
diff --git a/author.yml b/author.yml
@@ -0,0 +1,5 @@
+ApacheDoris:
+  name: Apache Doris
+  # other author properties...
+  socials:
+    x: doris_apache
diff --git a/babel.config.js b/babel.config.js
diff --git a/check_move.py b/check_move.py
@@ -62,7 +62,6 @@ def process_md_file(file_path):
                         from_base == to_base
                     ):
                         continue
-
                     # In md, the link relative path starts from the directory where the document is located, not the document
                     relative_to_path = os.path.relpath(
                         to_path, os.path.dirname(file_path)

diff --git a/common_docs_zh/ecosystem/flink-doris-connector.md b/common_docs_zh/ecosystem/flink-doris-connector.md
@@ -880,7 +880,7 @@ Flink 在数据导入时，如果有脏数据，比如字段格式、长度等
 
 出现这个问题主要是条件 varchar/string 类型，需要加引号导致的，正确写法是 xxx = ''xxx'',这样 Flink SQL 解析器会将两个连续的单引号解释为一个单引号字符，而不是字符串的结束，并将拼接后的字符串作为属性的值。比如说：`t1 >= '2024-01-01'`，可以写成`'doris.filter.query' = 't1 >=''2024-01-01'''`。Connector1.6.0 之后 FlinkSQL 可以实现自动谓词和投影下推。
 
-15. **如果出现 Failed to connect to backend: http://host:webserver_port, 并且 Be 还是活着的**
+15. **如果出现 Failed to connect to backend: `http://host:webserver_port`, 并且 Be 还是活着的**
 
 可能是因为你配置的 be 的 ip，外部的 Flink 集群无法访问。这主要是因为当连接 fe 时，会通过 fe 解析出 be 的地址。例如，当你添加的 be 地址为`127.0.0.1`，那么 Flink 通过 fe 获取的 be 地址就为`127.0.0.1:webserver_port`，此时 Flink 就会去访问这个地址。当出现这个问题时，可以通过在 with 属性中增加实际对应的 be 外部 ip 地`'benodes' = "be_ip:webserver_port, be_ip:webserver_port..."`，整库同步则可增加`--sink-conf benodes=be_ip:webserver,be_ip:webserver...`。
 

diff --git a/config/custom-docusaurus-plugin.js b/config/custom-docusaurus-plugin.js
@@ -1,16 +1,13 @@
 const path = require('path');
-
+const publicPath = process.env.TEST_ENV_URL || 'https://cdnd.selectdb.com';
 module.exports = function (context, options) {
     return {
         name: 'custom-docusaurus-plugin',
         configureWebpack(config, isServer, utils) {
             return {
                 output: {
                     ...config.output,
-                    publicPath:
-                        context.i18n.currentLocale === 'en'
-                            ? 'https://cdnd.selectdb.com/'
-                            : 'https://cdnd.selectdb.com/zh-CN/',
+                    publicPath: context.i18n.currentLocale === 'en' ? `${publicPath}/` : `${publicPath}/zh-CN/`,
                 },
             };
         },

diff --git a/config/ssrTemplate.js b/config/ssrTemplate.js
@@ -1,3 +1,5 @@
+const fetchUrl = `'${process.env.TEST_ENV_URL}'` || 'https://cdnd.selectdb.com';
+
 module.exports = {
     ssrTemplate: `<!DOCTYPE html>
 <html <%~ it.htmlAttributes %>>
@@ -13,10 +15,10 @@ module.exports = {
       <%~ metaAttribute %>
     <% }); %>
     <% it.stylesheets.forEach((stylesheet) => { %>
-      <link rel="stylesheet" href="<%= 'https://cdnd.selectdb.com' %><%= it.baseUrl %><%= stylesheet %>" />
+      <link rel="stylesheet" href="<%= ${fetchUrl} %><%= it.baseUrl %><%= stylesheet %>" />
     <% }); %>
     <% it.scripts.forEach((script) => { %>
-      <link rel="preload" href="<%= 'https://cdnd.selectdb.com' %><%= it.baseUrl %><%= script %>" as="script">
+      <link rel="preload" href="<%= ${fetchUrl} %><%= it.baseUrl %><%= script %>" as="script">
     <% }); %>
   </head>
   <body <%~ it.bodyAttributes %>>
@@ -25,7 +27,7 @@ module.exports = {
       <%~ it.appHtml %>
     </div>
     <% it.scripts.forEach((script) => { %>
-      <script src="<%= 'https://cdnd.selectdb.com' %><%= it.baseUrl %><%= script %>"></script>
+      <script src="<%= ${fetchUrl} %><%= it.baseUrl %><%= script %>"></script>
     <% }); %>
     <%~ it.postBodyTags %>
   </body>

diff --git a/cspell.json b/cspell.json
@@ -17,4 +17,4 @@
     ],
     "ignoreWords": [],
     "import": []
-}
+}
diff --git a/docs/admin-manual/cluster-management/fqdn.md b/docs/admin-manual/cluster-management/fqdn.md
@@ -71,7 +71,7 @@ After deploying the cluster according to 'Enable FQDN for new cluster', if you w
 
 ### Enable FQDN for old cluster
 
-Precondition: The current program supports the syntax 'Alter SYSTEM MODIFY FRONTEND'<fe_ip>:<edit_log_port>'HOSTNAME'<fe_hostname>',
+Precondition: The current program supports the syntax `ALTER SYSTEM MODIFY FRONTEND "<fe_ip>:<edit_log_port>" HOSTNAME "<fe_hostname>"`,
 If not, upgrade to a version that supports the syntax
 
 >Note that.

diff --git a/...cluster-deployment/k8s-deploy/compute-storage-coupled/install-config-cluster.md b/...cluster-deployment/k8s-deploy/compute-storage-coupled/install-config-cluster.md
@@ -116,24 +116,17 @@ metadata:
 data:
   fe.conf: |
     CUR_DATE=`date +%Y%m%d-%H%M%S`
-
     # the output dir of stderr and stdout
     LOG_DIR = ${DORIS_HOME}/log
-
     JAVA_OPTS="-Djavax.security.auth.useSubjectCredsOnly=false -Xss4m -Xmx8192m -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.$CUR_DATE"
-
     # For jdk 9+, this JAVA_OPTS will be used as default JVM options
     JAVA_OPTS_FOR_JDK_9="-Djavax.security.auth.useSubjectCredsOnly=false -Xss4m -Xmx8192m -XX:SurvivorRatio=8 -XX:MaxTenuringThreshold=7 -XX:+CMSClassUnloadingEnabled -XX:-CMSParallelRemarkEnabled -XX:CMSInitiatingOccupancyFraction=80 -XX:SoftRefLRUPolicyMSPerMB=0 -Xlog:gc*:$DORIS_HOME/log/fe.gc.log.$CUR_DATE:time"
-
     # INFO, WARN, ERROR, FATAL
     sys_log_level = INFO
-
     # NORMAL, BRIEF, ASYNC
     sys_log_mode = NORMAL
-
     # Default dirs to put jdbc drivers,default value is ${DORIS_HOME}/jdbc_drivers
     # jdbc_drivers_dir = ${DORIS_HOME}/jdbc_drivers
-
     http_port = 8030
     rpc_port = 9020
     query_port = 9030
@@ -155,6 +148,7 @@ spec:
       configMapName: fe-conf
       resolveKey: fe.conf
 ```
+Update the configuration to the [DorisCluster resource](install-quickstart.md#step-3-deploy-doris-cluster) that needs to be deployed.
 
 :::tip Tip
 Please ensure that `enable_fqdn_mode=true` is included in the startup configuration.. If you want to use IP mode and K8s have the ability that the pod IP keep the same after restarted, please refer to the issue [#138](https://github.com/apache/doris-operator/issues/138) to config.

diff --git a/...all/cluster-deployment/k8s-deploy/compute-storage-coupled/install-quickstart.md b/...all/cluster-deployment/k8s-deploy/compute-storage-coupled/install-quickstart.md
@@ -109,4 +109,4 @@ The Doris cluster is quickly deployed in the test environment. You can enter the
 3. Use MySQL Client to connect to the Doris cluster in the FE container:
    ```shell
    mysql -uroot -P9030 -h127.0.0.1
-   ```
+   ```
diff --git a/...install/source-install/compilation-arm.md → ...nstall/source-install/compilation-arm.mdx b/...install/source-install/compilation-arm.md → ...nstall/source-install/compilation-arm.mdx
@@ -5,8 +5,7 @@
 }
 ---
 
-<!-- 
-Licensed to the Apache Software Foundation (ASF) under one
+{/* 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
@@ -21,8 +20,8 @@ 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.
--->
+under the License. */}
+
 
 import Tabs from '@theme/Tabs';
 import TabItem from '@theme/TabItem';
@@ -520,7 +519,7 @@ If you still encounter problems when compiling or starting, please consult the [
 
        > fatal error: curl/curl.h: No such file or directory
        >
-       >  2 |     #include <curl/curl.h>
+       >  2 |     #include &lt;curl/curl.h>
        >
        > compilation terminated.
        >

diff --git a/...esign/data-partitioning/basic-concepts.md → ...sign/data-partitioning/basic-concepts.mdx b/...esign/data-partitioning/basic-concepts.md → ...sign/data-partitioning/basic-concepts.mdx
@@ -5,8 +5,8 @@
 }
 ---
 
-<!--
-Licensed to the Apache Software Foundation (ASF) under one
+
+{/* 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
@@ -21,8 +21,8 @@ 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.
--->
+under the License. */}
+
 
 import Tabs from '@theme/Tabs';
 import TabItem from '@theme/TabItem';
-Original file line number
+Diff line change
@@ Expand Up / @@ -17,4 +17,4 @@ @@
         ],
         "ignoreWords": [],
         "import": []
-    }
+    }