Merge branch 'apache:master' into master

Author: KassieZ

auto_correct_format.py

@@ -0,0 +1,24 @@
+import os
+import sys
+import subprocess
+
+def list_files(directory):
+    """Recursively traverse the directory and print all .md and .mdx file names, then run autocorrect"""
+    for root, _, files in os.walk(directory):
+        for file in files:
+            if file.endswith(('.md', '.mdx')):
+                file_path = os.path.join(root, file)
+                print(file_path)
+                subprocess.run(["autocorrect", "--fix", file_path], check=True)
+
+if __name__ == "__main__":
+    if len(sys.argv) != 2:
+        print("Usage: python script.py <directory_path>")
+        sys.exit(1)
+    
+    dir_path = sys.argv[1]
+    if os.path.isdir(dir_path):
+        list_files(dir_path)
+    else:
+        print("The entered path is invalid. Please enter a valid directory path.")
+

docs/admin-manual/auth/authentication-and-authorization.md

@@ -73,7 +73,7 @@ Doris supports the following password policies to assist users in better passwor
 
 1. `PASSWORD_HISTORY`
 
-    Determines whether a user can reuse a historical password when resetting their current password. For example, `PASSWORD_HISTORY 10` means the last 10 passwords cannot be reused as a new password. Setting `PASSWORD_HISTORY DEFAULT` will use the value from the global variable `password_history`. A setting of 0 disables this feature. The default is 0.
+    Determines whether a user can reuse a historical password when resetting their current password. For example, `PASSWORD_HISTORY 10` means the last 10 passwords cannot be reused as a new password. Setting `PASSWORD_HISTORY DEFAULT` will use the value from the global variable `PASSWORD_HISTORY`. A setting of 0 disables this feature. The default is 0.
 
     Examples:
 
@@ -308,7 +308,7 @@ Please refer to [Authorization Scheme Based on Apache Ranger](./ranger.md).
 
 3. SET PASSWORD
 
-    - Users with ADMIN privileges or GLOBAL level GRANT privileges can set passwords for non-ROOT users.
+    - Users with ADMIN privileges or GLOBAL level GRANT privileges can set passwords for non-root users.
     - Ordinary users can set the password for their corresponding User Identity. Their corresponding User Identity can be viewed with the `SELECT CURRENT_USER()` command.
     - ROOT users can change their own password.
 

docs/admin-manual/auth/authentication/federation.md

@@ -1,3 +1,4 @@
+
 ---
 {
 "title": "Federated Authentication",
@@ -115,7 +116,7 @@ Assuming `jack` also belongs to LDAP groups `doris_qa` and `doris_pm`; and Doris
 
 > Note:
 >
-> Which group a user belongs to is unrelated to the organizational structure of the LDAP tree. The user2 in the example does not necessarily belong to group2.
+> The group a user belongs to is unrelated to the organizational structure of the LDAP tree. User2 in the example does not necessarily belong to group2.
 
 ### LDAP Example
 #### Modify Doris Configuration
@@ -147,7 +148,7 @@ To avoid frequent access to the LDAP service, Doris caches LDAP information in m
 
 - How to determine which roles an LDAP user has in Doris?
 
-  Log in to Doris using the LDAP user and execute `show grants;` to view the roles of the current user. Among them, ldapDefaultRole is the default role that each LDAP user has in Doris.
+  Log in to Doris using the LDAP user and execute `show grants;` to view the roles of the current user. `ldapDefaultRole` is the default role that each LDAP user has in Doris.
 
 - Why does an LDAP user have fewer roles in Doris than expected?
 

docs/admin-manual/auth/ldap.md

@@ -34,7 +34,7 @@ LDAP group authorization, is to map the group in LDAP to the Role in Doris, if t
 
 ## Noun Interpretation
 
-* LDAP: Lightweight directory access protocol that enables centralized management of account passwords.
+* LDAP: Lightweight Directory Access Protocol that enables centralized management of account passwords.
 * Privilege: Permissions act on nodes, databases or tables. Different permissions represent different permission to operate.
 * Role: Doris can create custom named roles. A role can be thought of as a collection of permissions.
 
@@ -81,7 +81,7 @@ and the LDAP administrator password needs to be set using sql statements.
   LDAP administrator account "Distinguished Name". When a user logs into Doris using LDAP authentication, Doris will bind the administrator account to search for user information in LDAP.
 
 * ldap_user_basedn = ou=people,dc=domain,dc=com
-  Doris base dn when searching for user information in LDAP,For example, only user2 in the above example is allowed to log in to Doris, which is configured as ou=ou2, dc=example, dc=com. If user1, user2, and user3 in the above example are allowed to log in to Doris, which is configured as dc=example, dc=com
+  Doris base DN(Distinguished Name) when searching for user information in LDAP,For example, only user2 in the above example is allowed to log in to Doris, which is configured as ou=ou2, dc=example, dc=com. If user1, user2, and user3 in the above example are allowed to log in to Doris, which is configured as dc=example, dc=com
 
 * ldap_user_filter = (&(uid={login}))
 
@@ -106,7 +106,7 @@ set ldap_admin_password = password('ldap_admin_password');
 #### MySQL Client
 Client-side LDAP authentication requires the mysql client-side explicit authentication plugin to be enabled. Logging into Doris using the command line enables the mysql explicit authentication plugin in one of two ways.
 
-* Set the environment variable LIBMYSQL_ENABLE_CLEARTEXT_PLUGIN to value 1.
+* Set the environment variable `LIBMYSQL_ENABLE_CLEARTEXT_PLUGIN` to value 1.
   For example, in a linux or max environment you can use the command:
   ```shell
   echo "export LIBMYSQL_ENABLE_CLEARTEXT_PLUGIN=1" >> ～/.bash_profile && source ～/.bash_profile

docs/admin-manual/auth/ranger.md

@@ -70,7 +70,7 @@ In version 2.1.0, Doris supports unified permission management by integrating Ap
 
 	The service address port can be viewed in the `ranger.service.http.port` configuration item of the `ranger-admin-site.xml` configuration file.
 
-	If the execution is successful, the service definition in Json format will be returned, such as:
+	If the execution is successful, the service definition in JSON format will be returned, such as:
 
 	```
 	{
@@ -243,40 +243,40 @@ Afterwards, you can see the created service in the Apache Doris plug-in on the S
 2. Using the `admin` user in Doris, create a Catalog named `hive`.
 3. Create `user1` in Ranger.
 
-#### Global Priv
+#### Global Privileges
 Equivalent to Doris' internal authorization statement `grant select_priv on *.*.* to user1`;
 - The global option can be found in the dropdown menu of the same level in the catalog
 - Only `*` can be entered in the input box 
 
   ![global](/images/ranger/global.png)
 
-#### Catalog Priv
+#### Catalog Privileges
 Equivalent to Doris' internal authorization statement `grant select_priv on hive.*.* to user1`;
 
 ![catalog](/images/ranger/catalog.png)
 
-#### Database Priv
+#### Database Privileges
 Equivalent to Doris' internal authorization statement `grant select_priv on hive.tpch.* to user1`;
 
 ![database](/images/ranger/database.png)
 
-#### Table Priv
+#### Table Privileges
 Equivalent to Doris' internal authorization statement `grant select_priv on hive.tpch.user to user1`;
 
 ![table](/images/ranger/table.png)
 
-#### Column Priv
+#### Column Privileges
 Equivalent to Doris' internal authorization statement `grant select_priv(name,age) on hive.tpch.user to user1`;
 
 ![column](/images/ranger/column.png)
 
-#### Resource Priv
+#### Resource Privileges
 Equivalent to Doris' internal authorization statement `grant usage_priv on resource 'resource1' to user1`;
 - The resource option can be found in the dropdown menu of the same level in the catalog
 
 ![resource](/images/ranger/resource.png)
 
-#### Workload Group Priv
+#### Workload Group Privileges
 Equivalent to Doris' internal authorization statement `grant usage_priv on workload group 'group1' to user1`;
 - The workload group option can be found in the dropdown menu of the same level in the catalog
 

docs/admin-manual/auth/user-privilege.md

@@ -26,13 +26,13 @@ under the License.
 
 # Authority Management
 
-Doris's new privilege management system refers to Mysql's privilege management mechanism, achieves table-level fine-grained privilege control, role-based privilege access control, and supports whitelist mechanism.
+Doris's new privilege management system refers to MySQL's privilege management mechanism, achieves table-level fine-grained privilege control, role-based privilege access control, and supports whitelist mechanism.
 
 ## Noun Interpretation
 
 1. user_identity
 
-	In a permission system, a user is identified as a User Identity. User ID consists of two parts: username and userhost. Username is a user name, which is composed of English upper and lower case. Userhost represents the IP from which the user link comes. User_identity is presented as username@'userhost', representing the username from userhost.
+	In a permission system, a user is identified as a User Identity. User ID consists of two parts: username and userhost. Username is a user name, which is composed of English uppercase and lowercase. Userhost represents the IP from which the user link comes. User_identity is presented as username@'userhost', representing the username from userhost.
 
 	Another expression of user_identity is username@['domain'], where domain is the domain name, which can be resolved into a set of IPS by DNS . The final expression is a set of username@'userhost', so we use username@'userhost'to represent it.
 
@@ -42,7 +42,7 @@ Doris's new privilege management system refers to Mysql's privilege management m
 
 3. Role
 
-	Doris can create custom named roles. Roles can be seen as a set of permissions. When a newly created user can be assigned a role, the role's permissions are automatically granted. Subsequent changes in the role's permissions will also be reflected in all user permissions that belong to the role.
+	Doris can create custom named roles. Roles can be seen as a set of permissions. When a newly created role can be assigned to a user, the role's permissions are automatically granted. Subsequent changes in the role's permissions will also be reflected in all user permissions that belong to the role.
 
 4. user_property
 
@@ -172,7 +172,7 @@ The workload group has only one level:
 
 ## ADMIN /GRANT
 
-ADMIN_PRIV and GRANT_PRIV have the authority of **"grant authority"** at the same time, which is more special. The operations related to these two privileges are described here one by one.
+ADMIN_PRIV and GRANT_PRIV have the authority of **"grant authority"** at the same time, which is more special. The operations related to these two privileges are described here individually.
 
 1. CREATE USER
 
@@ -247,7 +247,7 @@ ADMIN_PRIV and GRANT_PRIV have the authority of **"grant authority"** at the sam
 
 5. Forget passwords
 
-	If you forget your password and cannot log in to Doris, you can add `skip_localhost_auth_check` in fe config and restart FE so that logging to Doris without a password in localhost.
+	If you forget your password and cannot log in to Doris, you can add `skip_localhost_auth_check` in fe config and restart FE so that login to Doris without a password in localhost.
 
 	`skip_localhost_auth_check = true`
 
@@ -267,7 +267,7 @@ ADMIN_PRIV and GRANT_PRIV have the authority of **"grant authority"** at the sam
 
 	All privileges are given to a `current_user`, and the real user has all the privileges of the corresponding `current_user`.
         
-        `SELECT session_user()`  is supported , which is having same behaviour as user() function.
+        `SELECT session_user()`  is supported , which is having same behavior as user() function.
 
 10. Password Validation
 
@@ -289,7 +289,7 @@ Here are some usage scenarios of Doris privilege system.
 
 3. Blacklist
 
-    Doris itself does not support blacklist, only whitelist, but we can simulate blacklist in some way. Suppose you first create a user named `user@'192.%'`, which allows users from `192.*` to login. At this time, if you want to prohibit users from `192.168.10.1` from logging in, you can create another user with `cmy@'192.168.10.1'` and set a new password. Since `192.168.10.1` has a higher priority than `192.%`, user can no longer login by using the old password from `192.168.10.1`.
+    Doris itself does not support blacklist, only whitelist, but we can simulate blacklist in some way. Suppose you first create a user named `user@'192.%'`, which allows users from `192.*` to login. At this time, if you want to prohibit users from `192.168.10.1` from logging in, you can create another user with `user@'192.168.10.1'` and set a new password. Since `192.168.10.1` has a higher priority than `192.%`, user can no longer login by using the old password from `192.168.10.1`.
 
 ## More help
 

docs/admin-manual/cluster-management/elastic-expansion.md

@@ -66,7 +66,7 @@ fe/bin/start_fe.sh --helper <leader_fe_host>:<edit_log_port> --daemon
     ALTER SYSTEM ADD FOLLOWER "<follower_host>:<edit_log_port>";
     ```
 
-  * Register the node as a Observer FE:
+  * Register the node as an Observer FE:
 
     ```sql
     ALTER SYSTEM ADD OBSERVER "<observer_host>:<edit_log_port>";

docs/admin-manual/cluster-management/fqdn.md

@@ -28,16 +28,14 @@ under the License.
 
 This article introduces how to enable the use of Apache Doris based on FQDN (Fully Qualified Domain Name). FQDN is the complete domain name of a specific computer or host on the Internet.
 
-After Doris supports FQDN, communication between nodes is entirely based on FQDN. When adding various types of nodes, the FQDN should be directly specified. For example, the command to add a BE node is' ALTER SYSTEM ADD BACKEND "be_host:heartbeat_service_port",
-
-'be_host' was previously the IP address of the BE node. After starting the FQDN, be_host should specify the FQDN of the BE node.
+After Doris supports FQDN, communication between nodes is entirely based on FQDN. When adding various types of nodes, the FQDN should be directly specified. For example, the command to add a BE node is' ALTER SYSTEM ADD BACKEND "be_host:heartbeat_service_port", 'be_host' was previously the IP address of the BE node. After starting the FQDN, be_host should specify the FQDN of the BE node.
 
 ## Preconditions
 
 1. fe.conf file set `enable_fqdn_mode = true`.
 2. All machines in the cluster must be configured with a host name.
 3. The IP address and FQDN corresponding to other machines in the cluster must be specified in the '/etc/hosts' file for each machine in the cluster.
-4. /The etc/hosts file cannot have duplicate IP addresses.
+4. The /etc/hosts file cannot have duplicate IP addresses.
 
 ## Best Practices
 
@@ -54,7 +52,7 @@ After Doris supports FQDN, communication between nodes is entirely based on FQDN
    172.22.0.5 be2
    172.22.0.6 be3
    ```
-4. Verification: It can 'ping fe2' on FE1, and can resolve the correct IP address and ping it, indicating that the network environment is available.
+4. Verification: you can 'ping fe2' on FE1, and can resolve the correct IP address and ping it, indicating that the network environment is available.
 5. fe.conf settings for each FE node ` enable_ fqdn_ mode = true`.
 6. Refer to[Standard deployment](../../../versioned_docs/version-2.1/install/deploy-manually/integrated-storage-compute-deploy-manually)
 7. Select several machines to deploy broker on six machines as needed, and execute `ALTER SYSTEM ADD BROKER broker_name "fe1:8000","be1:8000",...;`.

docs/admin-manual/cluster-management/load-balancing.md

@@ -285,7 +285,7 @@ Here is the main content of the configuration file `proxysql.cnf`:
 datadir="/var/lib/proxysql"         #Data directory
 admin_variables=
 {
-    admin_credentials="admin:admin"  # Admin databse username and password.
+    admin_credentials="admin:admin"  # Admin database username and password.
     mysql_ifaces="0.0.0.0:6032"    # Admin database port, used for connecting admin database of ProxySQL
 }
 mysql_variables=
@@ -480,7 +480,7 @@ ProxySQL > save mysql servers to disk;
 Query OK, 0 rows affected (0.348 sec)
 ```
 
-Verify monitoring results.
+Verification monitoring results.
 
 The metrics of the ProxySQL monitoring module are all saved in the `monitor.log` table.