From 7ac8dcb2cb8a43fd73e032334debc98bfded529f Mon Sep 17 00:00:00 2001
From: dnskr <dnskrv88@gmail.com>
Date: Sun, 23 Feb 2025 23:55:05 +0100
Subject: [PATCH] [DOC] Refine monitoring docs

Signed-off-by: dnskr <dnskrv88@gmail.com>
---
 docs/monitor/events.md                        | 19 -------------------
 docs/monitor/index.rst                        |  3 +--
 docs/monitor/logging.md                       |  7 +++----
 docs/monitor/metrics.md                       |  2 +-
 ...trouble_shooting.md => troubleshooting.md} |  2 +-
 5 files changed, 6 insertions(+), 27 deletions(-)
 delete mode 100644 docs/monitor/events.md
 rename docs/monitor/{trouble_shooting.md => troubleshooting.md} (99%)

diff --git a/docs/monitor/events.md b/docs/monitor/events.md
deleted file mode 100644
index fd8d91ca026..00000000000
--- a/docs/monitor/events.md
+++ /dev/null
@@ -1,19 +0,0 @@
-<!--
-- 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.
--->
-
-# Monitoring Kyuubi - Events System
-
diff --git a/docs/monitor/index.rst b/docs/monitor/index.rst
index c69c023b6f3..e4299ef8ab8 100644
--- a/docs/monitor/index.rst
+++ b/docs/monitor/index.rst
@@ -20,9 +20,8 @@ In this section, you will learn how to monitor Kyuubi with logging, metrics etc.
 
 .. toctree::
     :maxdepth: 2
-    :numbered: 3
     :glob:
 
     logging
     metrics
-    trouble_shooting
+    troubleshooting
diff --git a/docs/monitor/logging.md b/docs/monitor/logging.md
index d459734306d..952dceb3969 100644
--- a/docs/monitor/logging.md
+++ b/docs/monitor/logging.md
@@ -15,7 +15,7 @@
 - limitations under the License.
 -->
 
-# Monitoring Kyuubi - Logging System
+# Logging
 
 Kyuubi uses [Apache Log4j2](https://logging.apache.org/log4j/2.x/) for logging since version v1.5.0. For versions v1.4.1 and below, it uses [Apache Log4j](https://logging.apache.org).
 
@@ -310,9 +310,8 @@ You will both get the final results and the corresponding operation logs telling
 
 ## Further Readings
 
-- [Monitoring Kyuubi - Events System](events.md)
-- [Monitoring Kyuubi - Server Metrics](metrics.md)
-- [Trouble Shooting](trouble_shooting.md)
+- [Metrics](metrics.md)
+- [Troubleshooting](troubleshooting.md)
 - Spark Online Documentation
   - [Monitoring and Instrumentation](https://spark.apache.org/docs/latest/monitoring.html)
 
diff --git a/docs/monitor/metrics.md b/docs/monitor/metrics.md
index d1d8b551137..fd8eb3afaa3 100644
--- a/docs/monitor/metrics.md
+++ b/docs/monitor/metrics.md
@@ -15,7 +15,7 @@
 - limitations under the License.
 -->
 
-# Monitoring Kyuubi - Server Metrics
+# Metrics
 
 Kyuubi has a configurable metrics system based on the [Dropwizard Metrics Library](https://metrics.dropwizard.io/).
 This allows users to report Kyuubi metrics to a variety of `kyuubi.metrics.reporters`.
diff --git a/docs/monitor/trouble_shooting.md b/docs/monitor/troubleshooting.md
similarity index 99%
rename from docs/monitor/trouble_shooting.md
rename to docs/monitor/troubleshooting.md
index 9c1bab71ba4..97f2922afad 100644
--- a/docs/monitor/trouble_shooting.md
+++ b/docs/monitor/troubleshooting.md
@@ -15,7 +15,7 @@
 - limitations under the License.
 -->
 
-# Trouble Shooting
+# Troubleshooting
 
 ## Common Issues