[KYUUBI #4161] [DOCS] Refine settings page with correction in grammar…

… and spelling mistakes of config descriptions ### _Why are the changes needed?_ As Kyuubi graduated as top level project, the setting page will be more often requested and should be increasingly reliable and readable with less grammar and spelling mistakes. This PR is to - correct mistakes in grammar, spelling, abbreviation and terminology - with no config name or essential meanings changed ### _How was this patch tested?_ - [ ] Add some test cases that check the changes thoroughly including negative and positive cases if possible - [ ] Add screenshots for manual tests if appropriate - [x] [Run test](https://kyuubi.apache.org/docs/latest/develop_tools/testing.html#running-tests) locally before make a pull request Closes #4161 from bowenliang123/conf-grammar. Closes #4161 038edfb [liangbowen] nit 1ec073a [liangbowen] to JSON 4f5259a [liangbowen] to Prometheus 5238550 [liangbowen] to K8s fc7a3a8 [liangbowen] to AUTO-GENERATED da64f54 [liangbowen] update d54f9a5 [liangbowen] fix `comma separated` to `comma-separated` f1d7cc1 [liangbowen] update d842088 [liangbowen] update 1b75f01 [liangbowen] correction of grammar and spelling mistakes Authored-by: liangbowen <[email protected]> Signed-off-by: Kent Yao <[email protected]>
apache · Jan 16, 2023 · 89c7435 · 89c7435
1 parent 6237a54
commit 89c7435
Show file tree

Hide file tree

Showing 11 changed files with 329 additions and 320 deletions.
diff --git a/docs/deployment/settings.md b/docs/deployment/settings.md
diff --git a/docs/extensions/engines/spark/functions.md b/docs/extensions/engines/spark/functions.md
@@ -15,7 +15,7 @@
  - limitations under the License.
  -->
 
-<!-- DO NOT MODIFY THIS FILE DIRECTLY, IT IS AUTO GENERATED BY [org.apache.kyuubi.engine.spark.udf.KyuubiDefinedFunctionSuite] -->
+<!-- DO NOT MODIFY THIS FILE DIRECTLY, IT IS AUTO-GENERATED BY [org.apache.kyuubi.engine.spark.udf.KyuubiDefinedFunctionSuite] -->
 
 # Auxiliary SQL Functions
 

diff --git a/docs/monitor/metrics.md b/docs/monitor/metrics.md
@@ -28,10 +28,10 @@ The metrics system is configured via `$KYUUBI_HOME/conf/kyuubi-defaults.conf`.
 Key | Default | Meaning | Type | Since
 --- | --- | --- | --- | ---
 `kyuubi.metrics.enabled`|<div style='width: 65pt;word-wrap: break-word;white-space: normal'>true</div>|<div style='width: 170pt;word-wrap: break-word;white-space: normal'>Set to true to enable kyuubi metrics system</div>|<div style='width: 30pt'>boolean</div>|<div style='width: 20pt'>1.2.0</div>
-`kyuubi.metrics.reporters`|<div style='width: 65pt;word-wrap: break-word;white-space: normal'>JSON</div>|<div style='width: 170pt;word-wrap: break-word;white-space: normal'>A comma separated list for all metrics reporters<ul> <li>CONSOLE - ConsoleReporter which outputs measurements to CONSOLE periodically.</li> <li>JMX - JmxReporter which listens for new metrics and exposes them as MBeans.</li>  <li>JSON - JsonReporter which outputs measurements to json file periodically.</li> <li>PROMETHEUS - PrometheusReporter which exposes metrics in prometheus format.</li> <li>SLF4J - Slf4jReporter which outputs measurements to system log periodically.</li></ul></div>|<div style='width: 30pt'>seq</div>|<div style='width: 20pt'>1.2.0</div>
+`kyuubi.metrics.reporters`|<div style='width: 65pt;word-wrap: break-word;white-space: normal'>JSON</div>|<div style='width: 170pt;word-wrap: break-word;white-space: normal'>A comma-separated list for all metrics reporters<ul> <li>CONSOLE - ConsoleReporter which outputs measurements to CONSOLE periodically.</li> <li>JMX - JmxReporter which listens for new metrics and exposes them as MBeans.</li>  <li>JSON - JsonReporter which outputs measurements to json file periodically.</li> <li>PROMETHEUS - PrometheusReporter which exposes metrics in Prometheus format.</li> <li>SLF4J - Slf4jReporter which outputs measurements to system log periodically.</li></ul></div>|<div style='width: 30pt'>seq</div>|<div style='width: 20pt'>1.2.0</div>
 `kyuubi.metrics.console.interval`|<div style='width: 65pt;word-wrap: break-word;white-space: normal'>PT5S</div>|<div style='width: 170pt;word-wrap: break-word;white-space: normal'>How often should report metrics to console</div>|<div style='width: 30pt'>duration</div>|<div style='width: 20pt'>1.2.0</div>
-`kyuubi.metrics.json.interval`|<div style='width: 65pt;word-wrap: break-word;white-space: normal'>PT5S</div>|<div style='width: 170pt;word-wrap: break-word;white-space: normal'>How often should report metrics to json file</div>|<div style='width: 30pt'>duration</div>|<div style='width: 20pt'>1.2.0</div>
-`kyuubi.metrics.json.location`|<div style='width: 65pt;word-wrap: break-word;white-space: normal'>metrics</div>|<div style='width: 170pt;word-wrap: break-word;white-space: normal'>Where the json metrics file located</div>|<div style='width: 30pt'>string</div>|<div style='width: 20pt'>1.2.0</div>
+`kyuubi.metrics.json.interval`|<div style='width: 65pt;word-wrap: break-word;white-space: normal'>PT5S</div>|<div style='width: 170pt;word-wrap: break-word;white-space: normal'>How often should report metrics to JSON file</div>|<div style='width: 30pt'>duration</div>|<div style='width: 20pt'>1.2.0</div>
+`kyuubi.metrics.json.location`|<div style='width: 65pt;word-wrap: break-word;white-space: normal'>metrics</div>|<div style='width: 170pt;word-wrap: break-word;white-space: normal'>Where the JSON metrics file located</div>|<div style='width: 30pt'>string</div>|<div style='width: 20pt'>1.2.0</div>
 `kyuubi.metrics.prometheus.path`|<div style='width: 65pt;word-wrap: break-word;white-space: normal'>/metrics</div>|<div style='width: 170pt;word-wrap: break-word;white-space: normal'>URI context path of prometheus metrics HTTP server</div>|<div style='width: 30pt'>string</div>|<div style='width: 20pt'>1.2.0</div>
 `kyuubi.metrics.prometheus.port`|<div style='width: 65pt;word-wrap: break-word;white-space: normal'>10019</div>|<div style='width: 170pt;word-wrap: break-word;white-space: normal'>Prometheus metrics HTTP server port</div>|<div style='width: 30pt'>int</div>|<div style='width: 20pt'>1.2.0</div>
 `kyuubi.metrics.slf4j.interval`|<div style='width: 65pt;word-wrap: break-word;white-space: normal'>PT5S</div>|<div style='width: 170pt;word-wrap: break-word;white-space: normal'>How often should report metrics to SLF4J logger</div>|<div style='width: 30pt'>duration</div>|<div style='width: 20pt'>1.2.0</div>

diff --git a/...engine/src/test/scala/org/apache/kyuubi/engine/spark/udf/KyuubiDefinedFunctionSuite.scala b/...engine/src/test/scala/org/apache/kyuubi/engine/spark/udf/KyuubiDefinedFunctionSuite.scala
@@ -66,7 +66,7 @@ class KyuubiDefinedFunctionSuite extends KyuubiFunSuite {
     newOutput += " - limitations under the License."
     newOutput += " -->"
     newOutput += ""
-    newOutput += "<!-- DO NOT MODIFY THIS FILE DIRECTLY, IT IS AUTO GENERATED BY" +
+    newOutput += "<!-- DO NOT MODIFY THIS FILE DIRECTLY, IT IS AUTO-GENERATED BY" +
       " [org.apache.kyuubi.engine.spark.udf.KyuubiDefinedFunctionSuite] -->"
     newOutput += ""
     newOutput += "# Auxiliary SQL Functions"