This is an automated email from the ASF dual-hosted git repository.
chengpan pushed a commit to branch branch-1.10
in repository https://gitbox.apache.org/repos/asf/kyuubi.git
The following commit(s) were added to refs/heads/branch-1.10 by this push:
new 6aacf7a24d [KYUUBI #7224] [DOC] Fix "duplicate label usage" warnings
6aacf7a24d is described below
commit 6aacf7a24d611e97256d12a6f2eb1888e5ccbdae
Author: dnskr <[email protected]>
AuthorDate: Mon Oct 27 13:48:37 2025 +0800
[KYUUBI #7224] [DOC] Fix "duplicate label usage" warnings
### Why are the changes needed?
The main purpose of the PR is to fix the following `duplicate label usage`
warnings:
```shell
./kyuubi/docs/tools/kyuubi-admin.rst:48: WARNING: duplicate label usage,
other instance in ./kyuubi/docs/tools/index.rst
./kyuubi/docs/tools/kyuubi-ctl.rst:22: WARNING: duplicate label usage,
other instance in ./kyuubi/docs/tools/kyuubi-admin.rst
```
Changes:
- The PR deletes all labels from `./kyuubi/docs/tools/index.rst` and
`./kyuubi/docs/tools/kyuubi-admin.rst`, as they are not used (there are no
references to them).
- The PR also fixes the length of the punctuation used to highlight
section titles.
### How was this patch tested?
Checked that there are no warnings anymore during the documentation build
process and the pages look the same.
```shell
make html
```
### Was this patch authored or co-authored using generative AI tooling?
No
Closes #7224 from dnskr/doc-fix-duplicate-label-usage.
Closes #7224
0ff49db6a [dnskr] [DOC] Fix "duplicate label usage" warnings
Authored-by: dnskr <[email protected]>
Signed-off-by: Cheng Pan <[email protected]>
(cherry picked from commit ba248b17cb1ffa5b1845a0ccb68592cba72269b8)
Signed-off-by: Cheng Pan <[email protected]>
---
docs/tools/kyuubi-admin.rst | 29 +++++++----------------------
docs/tools/kyuubi-ctl.rst | 26 +++-----------------------
2 files changed, 10 insertions(+), 45 deletions(-)
diff --git a/docs/tools/kyuubi-admin.rst b/docs/tools/kyuubi-admin.rst
index 29149e92f5..4cfc93a726 100644
--- a/docs/tools/kyuubi-admin.rst
+++ b/docs/tools/kyuubi-admin.rst
@@ -14,16 +14,14 @@
limitations under the License.
Kyuubi Administer Tool
-=======================
+======================
.. versionadded:: 1.6.0
Kyuubi administer tool(kyuubi-admin) provides administrators with some
maintenance operations against a kyuubi server or cluster.
-.. _installation:
-
Installation
--------------------------------------
+------------
To install kyuubi-admin, you need to unpack the tarball. For example,
.. parsed-literal::
@@ -41,21 +39,14 @@ This will result in the creation of a subdirectory named
apache-kyuubi-|release|
│ ├── ...
├── ...
-
-.. _usage:
-
Usage
--------------------------------------
+-----
.. code-block:: bash
bin/kyuubi-admin --help
-
-
-.. _refresh_config:
-
Refresh config
--------------------------------------
+--------------
Refresh the config with specified type.
@@ -76,10 +67,8 @@ Usage: ``bin/kyuubi-admin refresh config [options]
[<configType>]``
* - denyUsers
- The user in the deny list will be denied to connect to kyuubi server.
-.. _list_engine:
-
List Engines
--------------------------------------
+------------
Prints a table of the key information about the specified engines.
@@ -100,19 +89,15 @@ Usage: ``bin/kyuubi-admin list engine [options]``
* - --hs2ProxyUser
- The proxy user to impersonate. When specified, it will list engines for
the hs2ProxyUser.
-.. _list_server:
-
List Servers
--------------------------------------
+------------
Prints a table of the key information about the servers.
Usage: ``bin/kyuubi-admin list server``
-.. _delete_engine:
-
Delete an Engine
--------------------------------------
+----------------
Delete the specified engine.
diff --git a/docs/tools/kyuubi-ctl.rst b/docs/tools/kyuubi-ctl.rst
index 407af4b56e..eb2565eb22 100644
--- a/docs/tools/kyuubi-ctl.rst
+++ b/docs/tools/kyuubi-ctl.rst
@@ -16,8 +16,6 @@
Administrator CLI
=================
-.. _usage:
-
Usage
-----
.. code-block:: bash
@@ -88,15 +86,11 @@ Output
-h, --help Show help message and exit.
-.. _manage_kyuubi_servers:
-
Manage kyuubi servers
---------------------
You can specify the zookeeper address(``--zk-quorum``) and
namespace(``--namespace``), version(``--version``) parameters to query a
specific kyuubi server cluster.
-.. _list_servers:
-
List server
***********
@@ -106,8 +100,6 @@ List all the service nodes for a particular domain.
bin/kyuubi-ctl list server
-.. _create_servers:
-
Create server
***********
Expose Kyuubi server instance to another domain.
@@ -118,10 +110,8 @@ First read ``kyuubi.ha.namespace`` in
``conf/kyuubi-defaults.conf``, if there ar
bin/kyuubi-ctl create server --namespace XXX
-.. _get_servers:
-
Get server
-***********
+**********
Get Kyuubi server info of domain.
@@ -129,8 +119,6 @@ Get Kyuubi server info of domain.
bin/kyuubi-ctl get server --host XXX --port YYY
-.. _delete_servers:
-
Delete server
***********
@@ -142,8 +130,6 @@ After the server node is deleted, the kyuubi server stops
opening new sessions a
bin/kyuubi-ctl delete server --host XXX --port YYY
-.. _manage_kyuubi_engines:
-
Manage kyuubi engines
---------------------
@@ -171,8 +157,6 @@ The ``--user`` parameter is the group name corresponding to
the user.
The ``--user`` parameter is the user who started the kyuubi server.
-.. _list_engines:
-
List engine
***********
@@ -188,10 +172,8 @@ The management share level is SERVER, the user who starts
the kyuubi server is A
bin/kyuubi-ctl list engine --user A --engine-type TRINO --engine-subdomain
adhoc --engine-share-level SERVER
-.. _get_engines:
-
Get engine
-***********
+**********
Get Kyuubi engine info belong to a user.
@@ -199,8 +181,6 @@ Get Kyuubi engine info belong to a user.
bin/kyuubi-ctl get engine --user AAA --host XXX --port YYY
-.. _delete_engines:
-
Delete engine
*************
@@ -210,4 +190,4 @@ After the engine node is deleted, the kyuubi engine stops
opening new sessions a
.. code-block:: bash
- bin/kyuubi-ctl delete engine --user AAA --host XXX --port YYY
\ No newline at end of file
+ bin/kyuubi-ctl delete engine --user AAA --host XXX --port YYY
