[DOCS] Refine settings page with correction in grammar and spelling mistakes of config descriptions

kyuubi-ctl/src/main/scala/org/apache/kyuubi/ctl/CtlConf.scala

@@ -28,7 +28,7 @@ object CtlConf {
   val CTL_REST_CLIENT_BASE_URL: OptionalConfigEntry[String] =
     buildConf("kyuubi.ctl.rest.base.url")
       .doc("The REST API base URL, " +
-        "which contains the scheme (http:// or https://), host name, port number")
+        "which contains the scheme (http:// or https://), hostname, port number")
       .version("1.6.0")
       .stringConf
       .createOptional
@@ -49,7 +49,7 @@ object CtlConf {
 
   val CTL_REST_CLIENT_CONNECT_TIMEOUT: ConfigEntry[Long] =
     buildConf("kyuubi.ctl.rest.connect.timeout")
-      .doc("The timeout[ms] for establishing the connection with the kyuubi server." +
+      .doc("The timeout[ms] for establishing the connection with the kyuubi server. " +
         "A timeout value of zero is interpreted as an infinite timeout.")
       .version("1.6.0")
       .timeConf
@@ -58,7 +58,7 @@ object CtlConf {
 
   val CTL_REST_CLIENT_SOCKET_TIMEOUT: ConfigEntry[Long] =
     buildConf("kyuubi.ctl.rest.socket.timeout")
-      .doc("The timeout[ms] for waiting for data packets after connection is established." +
+      .doc("The timeout[ms] for waiting for data packets after connection is established. " +
         "A timeout value of zero is interpreted as an infinite timeout.")
       .version("1.6.0")
       .timeConf

kyuubi-ha/src/main/scala/org/apache/kyuubi/ha/HighAvailabilityConf.scala

@@ -31,7 +31,7 @@ object HighAvailabilityConf {
 
   @deprecated("using kyuubi.ha.addresses instead", "1.6.0")
   val HA_ZK_QUORUM: ConfigEntry[String] = buildConf("kyuubi.ha.zookeeper.quorum")
-    .doc("(deprecated) The connection string for the zookeeper ensemble")
+    .doc("(deprecated) The connection string for the ZooKeeper ensemble")
     .version("1.0.0")
     .stringConf
     .createWithDefault("")
@@ -69,14 +69,14 @@ object HighAvailabilityConf {
     "1.3.2")
   val HA_ZK_ACL_ENABLED: ConfigEntry[Boolean] =
     buildConf("kyuubi.ha.zookeeper.acl.enabled")
-      .doc("Set to true if the zookeeper ensemble is kerberized")
+      .doc("Set to true if the ZooKeeper ensemble is kerberized")
       .version("1.0.0")
       .booleanConf
       .createWithDefault(UserGroupInformation.isSecurityEnabled)
 
   val HA_ZK_AUTH_TYPE: ConfigEntry[String] =
     buildConf("kyuubi.ha.zookeeper.auth.type")
-      .doc("The type of zookeeper authentication, all candidates are " +
+      .doc("The type of ZooKeeper authentication, all candidates are " +
         s"${AuthTypes.values.mkString("<ul><li>", "</li><li> ", "</li></ul>")}")
       .version("1.3.2")
       .stringConf
@@ -85,7 +85,7 @@ object HighAvailabilityConf {
 
   val HA_ZK_ENGINE_AUTH_TYPE: ConfigEntry[String] =
     buildConf("kyuubi.ha.zookeeper.engine.auth.type")
-      .doc("The type of zookeeper authentication for engine, all candidates are " +
+      .doc("The type of ZooKeeper authentication for the engine, all candidates are " +
         s"${AuthTypes.values.mkString("<ul><li>", "</li><li> ", "</li></ul>")}")
       .version("1.3.2")
       .stringConf
@@ -94,31 +94,31 @@ object HighAvailabilityConf {
 
   val HA_ZK_AUTH_PRINCIPAL: ConfigEntry[Option[String]] =
     buildConf("kyuubi.ha.zookeeper.auth.principal")
-      .doc("Name of the Kerberos principal is used for zookeeper authentication.")
+      .doc("Name of the Kerberos principal is used for ZooKeeper authentication.")
       .version("1.3.2")
       .fallbackConf(KyuubiConf.SERVER_PRINCIPAL)
 
   val HA_ZK_AUTH_KEYTAB: ConfigEntry[Option[String]] = buildConf("kyuubi.ha.zookeeper.auth.keytab")
-    .doc("Location of Kyuubi server's keytab is used for zookeeper authentication.")
+    .doc("Location of the Kyuubi server's keytab is used for ZooKeeper authentication.")
     .version("1.3.2")
     .fallbackConf(KyuubiConf.SERVER_KEYTAB)
 
   val HA_ZK_AUTH_DIGEST: OptionalConfigEntry[String] = buildConf("kyuubi.ha.zookeeper.auth.digest")
-    .doc("The digest auth string is used for zookeeper authentication, like: username:password.")
+    .doc("The digest auth string is used for ZooKeeper authentication, like: username:password.")
     .version("1.3.2")
     .stringConf
     .createOptional
 
   val HA_ZK_CONN_MAX_RETRIES: ConfigEntry[Int] =
     buildConf("kyuubi.ha.zookeeper.connection.max.retries")
-      .doc("Max retry times for connecting to the zookeeper ensemble")
+      .doc("Max retry times for connecting to the ZooKeeper ensemble")
       .version("1.0.0")
       .intConf
       .createWithDefault(3)
 
   val HA_ZK_CONN_BASE_RETRY_WAIT: ConfigEntry[Int] =
     buildConf("kyuubi.ha.zookeeper.connection.base.retry.wait")
-      .doc("Initial amount of time to wait between retries to the zookeeper ensemble")
+      .doc("Initial amount of time to wait between retries to the ZooKeeper ensemble")
       .version("1.0.0")
       .intConf
       .createWithDefault(1000)
@@ -133,7 +133,7 @@ object HighAvailabilityConf {
       .createWithDefault(30 * 1000)
 
   val HA_ZK_CONN_TIMEOUT: ConfigEntry[Int] = buildConf("kyuubi.ha.zookeeper.connection.timeout")
-    .doc("The timeout(ms) of creating the connection to the zookeeper ensemble")
+    .doc("The timeout(ms) of creating the connection to the ZooKeeper ensemble")
     .version("1.0.0")
     .intConf
     .createWithDefault(15 * 1000)
@@ -146,7 +146,7 @@ object HighAvailabilityConf {
 
   val HA_ZK_CONN_RETRY_POLICY: ConfigEntry[String] =
     buildConf("kyuubi.ha.zookeeper.connection.retry.policy")
-      .doc("The retry policy for connecting to the zookeeper ensemble, all candidates are:" +
+      .doc("The retry policy for connecting to the ZooKeeper ensemble, all candidates are:" +
         s" ${RetryPolicies.values.mkString("<ul><li>", "</li><li> ", "</li></ul>")}")
       .version("1.0.0")
       .stringConf
@@ -155,15 +155,15 @@ object HighAvailabilityConf {
 
   val HA_ZK_NODE_TIMEOUT: ConfigEntry[Long] =
     buildConf("kyuubi.ha.zookeeper.node.creation.timeout")
-      .doc("Timeout for creating zookeeper node")
+      .doc("Timeout for creating ZooKeeper node")
       .version("1.2.0")
       .timeConf
       .checkValue(_ > 0, "Must be positive")
       .createWithDefault(Duration.ofSeconds(120).toMillis)
 
   val HA_ENGINE_REF_ID: OptionalConfigEntry[String] =
     buildConf("kyuubi.ha.engine.ref.id")
-      .doc("The engine reference id will be attached to zookeeper node when engine started, " +
+      .doc("The engine reference id will be attached to ZooKeeper node when engine started, " +
         "and the kyuubi server will check it cyclically.")
       .internal
       .version("1.3.2")
@@ -172,7 +172,7 @@ object HighAvailabilityConf {
 
   val HA_ZK_PUBLISH_CONFIGS: ConfigEntry[Boolean] =
     buildConf("kyuubi.ha.zookeeper.publish.configs")
-      .doc("When set to true, publish Kerberos configs to Zookeeper." +
+      .doc("When set to true, publish Kerberos configs to Zookeeper. " +
         "Note that the Hive driver needs to be greater than 1.3 or 2.0 or apply HIVE-11581 patch.")
       .version("1.4.0")
       .booleanConf
@@ -189,16 +189,16 @@ object HighAvailabilityConf {
 
   val HA_ETCD_LEASE_TIMEOUT: ConfigEntry[Long] =
     buildConf("kyuubi.ha.etcd.lease.timeout")
-      .doc("Timeout for etcd keep alive lease. The kyuubi server will known " +
-        "unexpected loss of engine after up to this seconds.")
+      .doc("Timeout for etcd keep alive lease. The kyuubi server will know " +
+        "the unexpected loss of engine after up to this seconds.")
       .version("1.6.0")
       .timeConf
       .checkValue(_ > 0, "Must be positive")
       .createWithDefault(Duration.ofSeconds(10).toMillis)
 
   val HA_ETCD_SSL_ENABLED: ConfigEntry[Boolean] =
     buildConf("kyuubi.ha.etcd.ssl.enabled")
-      .doc("When set to true, will build a ssl secured etcd client.")
+      .doc("When set to true, will build an SSL secured etcd client.")
       .version("1.6.0")
       .booleanConf
       .createWithDefault(false)

kyuubi-server/src/main/scala/org/apache/kyuubi/server/metadata/jdbc/JDBCMetadataStoreConf.scala

@@ -38,11 +38,11 @@ object JDBCMetadataStoreConf {
   val METADATA_STORE_JDBC_DATABASE_TYPE: ConfigEntry[String] =
     buildConf("kyuubi.metadata.store.jdbc.database.type")
       .doc("The database type for server jdbc metadata store.<ul>" +
-        " <li>DERBY: Apache Derby, jdbc driver `org.apache.derby.jdbc.AutoloadedDriver`.</li>" +
-        " <li>MYSQL: MySQL, jdbc driver `com.mysql.jdbc.Driver`.</li>" +
-        " <li>CUSTOM: User-defined database type, need to specify corresponding jdbc driver.</li>" +
-        " Note that: The jdbc datasource is powered by HiKariCP, for datasource properties," +
-        " please specify them with prefix: kyuubi.metadata.store.jdbc.datasource." +
+        " <li>DERBY: Apache Derby, JDBC driver `org.apache.derby.jdbc.AutoloadedDriver`.</li>" +
+        " <li>MYSQL: MySQL, JDBC driver `com.mysql.jdbc.Driver`.</li>" +
+        " <li>CUSTOM: User-defined database type, need to specify corresponding JDBC driver.</li>" +
+        " Note that: The JDBC datasource is powered by HiKariCP, for datasource properties," +
+        " please specify them with the prefix: kyuubi.metadata.store.jdbc.datasource." +
         " For example, kyuubi.metadata.store.jdbc.datasource.connectionTimeout=10000.")
       .version("1.6.0")
       .serverOnly
@@ -52,7 +52,7 @@ object JDBCMetadataStoreConf {
 
   val METADATA_STORE_JDBC_DATABASE_SCHEMA_INIT: ConfigEntry[Boolean] =
     buildConf("kyuubi.metadata.store.jdbc.database.schema.init")
-      .doc("Whether to init the jdbc metadata store database schema.")
+      .doc("Whether to init the JDBC metadata store database schema.")
       .version("1.6.0")
       .serverOnly
       .booleanConf
@@ -68,25 +68,26 @@ object JDBCMetadataStoreConf {
 
   val METADATA_STORE_JDBC_URL: ConfigEntry[String] =
     buildConf("kyuubi.metadata.store.jdbc.url")
-      .doc("The jdbc url for server jdbc metadata store. By defaults, it is a DERBY in-memory" +
+      .doc("The JDBC url for server JDBC metadata store. By default, it is a DERBY in-memory" +
         " database url, and the state information is not shared across kyuubi instances. To" +
-        " enable multiple kyuubi instances high available, please specify a production jdbc url.")
+        " enable high availability for multiple kyuubi instances," +
+        " please specify a production JDBC url.")
       .version("1.6.0")
       .serverOnly
       .stringConf
       .createWithDefault("jdbc:derby:memory:kyuubi_state_store_db;create=true")
 
   val METADATA_STORE_JDBC_USER: ConfigEntry[String] =
     buildConf("kyuubi.metadata.store.jdbc.user")
-      .doc("The username for server jdbc metadata store.")
+      .doc("The username for server JDBC metadata store.")
       .version("1.6.0")
       .serverOnly
       .stringConf
       .createWithDefault("")
 
   val METADATA_STORE_JDBC_PASSWORD: ConfigEntry[String] =
     buildConf("kyuubi.metadata.store.jdbc.password")
-      .doc("The password for server jdbc metadata store.")
+      .doc("The password for server JDBC metadata store.")
       .version("1.6.0")
       .serverOnly
       .stringConf

kyuubi-server/src/test/scala/org/apache/kyuubi/config/AllKyuubiConfiguration.scala

@@ -120,7 +120,7 @@ class AllKyuubiConfiguration extends KyuubiFunSuite {
       " `kyuubi.engineEnv.VAR_NAME`. For example, with `kyuubi.engineEnv.SPARK_DRIVER_MEMORY=4g`," +
       " the environment variable `SPARK_DRIVER_MEMORY` with value `4g` would be transferred into" +
       " engine side. With `kyuubi.engineEnv.SPARK_CONF_DIR=/apache/confs/spark/conf`, the" +
-      " value of `SPARK_CONF_DIR` in engine side is set to `/apache/confs/spark/conf`."
+      " value of `SPARK_CONF_DIR` on the engine side is set to `/apache/confs/spark/conf`."
 
     newOutput += ""
     newOutput += "## Kyuubi Configurations"
@@ -194,7 +194,7 @@ class AllKyuubiConfiguration extends KyuubiFunSuite {
     newOutput += ""
     newOutput += ("  - For [Static SQL Configurations](" +
       "http://spark.apache.org/docs/latest/configuration.html#static-sql-configuration) and" +
-      " other spark core configs, e.g. `spark.executor.memory`, they will take affect if there" +
+      " other spark core configs, e.g. `spark.executor.memory`, they will take effect if there" +
       " is no existing SQL engine application. Otherwise, they will just be ignored")
     newOutput += ""
     newOutput += ("### Via SET Syntax")
@@ -257,7 +257,7 @@ class AllKyuubiConfiguration extends KyuubiFunSuite {
     newOutput += ""
     newOutput += ("### Hadoop Configurations")
     newOutput += ""
-    newOutput += ("Specifying `HADOOP_CONF_DIR` to the directory contains hadoop configuration" +
+    newOutput += ("Specifying `HADOOP_CONF_DIR` to the directory containing Hadoop configuration" +
       " files or treating them as Spark properties with a `spark.hadoop.` prefix." +
       " Please refer to the Spark official online documentation for" +
       " [Inheriting Hadoop Cluster Configuration](http://spark.apache.org/docs/latest/" +
@@ -269,7 +269,7 @@ class AllKyuubiConfiguration extends KyuubiFunSuite {
     newOutput += ""
     newOutput += ("These configurations are used for SQL engine application to talk to" +
       " Hive MetaStore and could be configured in a `hive-site.xml`." +
-      " Placed it in `$SPARK_HOME/conf` directory, or treating them as Spark properties with" +
+      " Placed it in `$SPARK_HOME/conf` directory, or treat them as Spark properties with" +
       " a `spark.hadoop.` prefix.")
 
     newOutput += ""

kyuubi-zookeeper/src/main/scala/org/apache/kyuubi/zookeeper/ZookeeperConf.scala

@@ -25,27 +25,27 @@ object ZookeeperConf {
 
   @deprecated("using kyuubi.zookeeper.embedded.client.port instead", since = "1.2.0")
   val EMBEDDED_ZK_PORT: ConfigEntry[Int] = buildConf("kyuubi.zookeeper.embedded.port")
-    .doc("The port of the embedded zookeeper server")
+    .doc("The port of the embedded ZooKeeper server")
     .version("1.0.0")
     .intConf
     .createWithDefault(2181)
 
   @deprecated("using kyuubi.zookeeper.embedded.data.dir instead", since = "1.2.0")
   val EMBEDDED_ZK_TEMP_DIR: ConfigEntry[String] = buildConf("kyuubi.zookeeper.embedded.directory")
-    .doc("The temporary directory for the embedded zookeeper server")
+    .doc("The temporary directory for the embedded ZooKeeper server")
     .version("1.0.0")
     .stringConf
     .createWithDefault("embedded_zookeeper")
 
   val ZK_CLIENT_PORT: ConfigEntry[Int] = buildConf("kyuubi.zookeeper.embedded.client.port")
-    .doc("clientPort for the embedded zookeeper server to listen for client connections," +
-      " a client here could be Kyuubi server, engine and JDBC client")
+    .doc("clientPort for the embedded ZooKeeper server to listen for client connections," +
+      " a client here could be Kyuubi server, engine, and JDBC client")
     .version("1.2.0")
     .fallbackConf(EMBEDDED_ZK_PORT)
 
   val ZK_CLIENT_PORT_ADDRESS: OptionalConfigEntry[String] =
     buildConf("kyuubi.zookeeper.embedded.client.port.address")
-      .doc("clientPortAddress for the embedded zookeeper server to")
+      .doc("clientPortAddress for the embedded ZooKeeper server to")
       .version("1.2.0")
       .stringConf
       .createOptional
@@ -57,35 +57,35 @@ object ZookeeperConf {
     .fallbackConf(EMBEDDED_ZK_TEMP_DIR)
 
   val ZK_DATA_LOG_DIR: ConfigEntry[String] = buildConf("kyuubi.zookeeper.embedded.data.log.dir")
-    .doc("dataLogDir for the embedded zookeeper server where writes the transaction log .")
+    .doc("dataLogDir for the embedded ZooKeeper server where writes the transaction log .")
     .version("1.2.0")
     .fallbackConf(ZK_DATA_DIR)
 
   val ZK_TICK_TIME: ConfigEntry[Int] = buildConf("kyuubi.zookeeper.embedded.tick.time")
-    .doc("tickTime in milliseconds for the embedded zookeeper server")
+    .doc("tickTime in milliseconds for the embedded ZooKeeper server")
     .version("1.2.0")
     .intConf
     .createWithDefault(3000)
 
   val ZK_MAX_CLIENT_CONNECTIONS: ConfigEntry[Int] =
     buildConf("kyuubi.zookeeper.embedded.max.client.connections")
-      .doc("maxClientCnxns for the embedded zookeeper server to limits the number of concurrent" +
+      .doc("maxClientCnxns for the embedded ZooKeeper server to limit the number of concurrent" +
         " connections of a single client identified by IP address")
       .version("1.2.0")
       .intConf
       .createWithDefault(120)
 
   val ZK_MIN_SESSION_TIMEOUT: ConfigEntry[Int] =
     buildConf("kyuubi.zookeeper.embedded.min.session.timeout")
-      .doc("minSessionTimeout in milliseconds for the embedded zookeeper server will allow the" +
+      .doc("minSessionTimeout in milliseconds for the embedded ZooKeeper server will allow the" +
         " client to negotiate. Defaults to 2 times the tickTime")
       .version("1.2.0")
       .intConf
       .createWithDefault(3000 * 2)
 
   val ZK_MAX_SESSION_TIMEOUT: ConfigEntry[Int] =
     buildConf("kyuubi.zookeeper.embedded.max.session.timeout")
-      .doc("maxSessionTimeout in milliseconds for the embedded zookeeper server will allow the" +
+      .doc("maxSessionTimeout in milliseconds for the embedded ZooKeeper server will allow the" +
         " client to negotiate. Defaults to 20 times the tickTime")
       .version("1.2.0")
       .intConf