Skip to content

Commit ba248b1

Browse files
dnskrpan3793
authored andcommitted
[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 0ff49db [dnskr] [DOC] Fix "duplicate label usage" warnings Authored-by: dnskr <dnskrv88@gmail.com> Signed-off-by: Cheng Pan <chengpan@apache.org>
1 parent 07d1d5f commit ba248b1

File tree

2 files changed

+10
-45
lines changed

2 files changed

+10
-45
lines changed

docs/tools/kyuubi-admin.rst

Lines changed: 7 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -14,16 +14,14 @@
1414
limitations under the License.
1515
1616
Kyuubi Administer Tool
17-
=======================
17+
======================
1818

1919
.. versionadded:: 1.6.0
2020

2121
Kyuubi administer tool(kyuubi-admin) provides administrators with some maintenance operations against a kyuubi server or cluster.
2222

23-
.. _installation:
24-
2523
Installation
26-
-------------------------------------
24+
------------
2725
To install kyuubi-admin, you need to unpack the tarball. For example,
2826

2927
.. parsed-literal::
@@ -41,21 +39,14 @@ This will result in the creation of a subdirectory named apache-kyuubi-|release|
4139
│ ├── ...
4240
├── ...
4341
44-
45-
.. _usage:
46-
4742
Usage
48-
-------------------------------------
43+
-----
4944
.. code-block:: bash
5045
5146
bin/kyuubi-admin --help
5247
53-
54-
55-
.. _refresh_config:
56-
5748
Refresh config
58-
-------------------------------------
49+
--------------
5950

6051
Refresh the config with specified type.
6152

@@ -76,10 +67,8 @@ Usage: ``bin/kyuubi-admin refresh config [options] [<configType>]``
7667
* - denyUsers
7768
- The user in the deny list will be denied to connect to kyuubi server.
7869

79-
.. _list_engine:
80-
8170
List Engines
82-
-------------------------------------
71+
------------
8372

8473
Prints a table of the key information about the specified engines.
8574

@@ -100,19 +89,15 @@ Usage: ``bin/kyuubi-admin list engine [options]``
10089
* - --hs2ProxyUser
10190
- The proxy user to impersonate. When specified, it will list engines for the hs2ProxyUser.
10291

103-
.. _list_server:
104-
10592
List Servers
106-
-------------------------------------
93+
------------
10794

10895
Prints a table of the key information about the servers.
10996

11097
Usage: ``bin/kyuubi-admin list server``
11198

112-
.. _delete_engine:
113-
11499
Delete an Engine
115-
-------------------------------------
100+
----------------
116101

117102
Delete the specified engine.
118103

docs/tools/kyuubi-ctl.rst

Lines changed: 3 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,6 @@
1616
Administrator CLI
1717
=================
1818

19-
.. _usage:
20-
2119
Usage
2220
-----
2321
.. code-block:: bash
@@ -88,15 +86,11 @@ Output
8886
8987
-h, --help Show help message and exit.
9088
91-
.. _manage_kyuubi_servers:
92-
9389
Manage kyuubi servers
9490
---------------------
9591

9692
You can specify the zookeeper address(``--zk-quorum``) and namespace(``--namespace``), version(``--version``) parameters to query a specific kyuubi server cluster.
9793

98-
.. _list_servers:
99-
10094
List server
10195
***********
10296

@@ -106,8 +100,6 @@ List all the service nodes for a particular domain.
106100
107101
bin/kyuubi-ctl list server
108102
109-
.. _create_servers:
110-
111103
Create server
112104
*************
113105

@@ -119,19 +111,15 @@ First read ``kyuubi.ha.namespace`` in ``conf/kyuubi-defaults.conf``, if there ar
119111
120112
bin/kyuubi-ctl create server --namespace XXX
121113
122-
.. _get_servers:
123-
124114
Get server
125-
***********
115+
**********
126116

127117
Get Kyuubi server info of domain.
128118

129119
.. code-block:: bash
130120
131121
bin/kyuubi-ctl get server --host XXX --port YYY
132122
133-
.. _delete_servers:
134-
135123
Delete server
136124
*************
137125

@@ -143,8 +131,6 @@ After the server node is deleted, the kyuubi server stops opening new sessions a
143131
144132
bin/kyuubi-ctl delete server --host XXX --port YYY
145133
146-
.. _manage_kyuubi_engines:
147-
148134
Manage kyuubi engines
149135
---------------------
150136

@@ -172,8 +158,6 @@ The ``--user`` parameter is the group name corresponding to the user.
172158

173159
The ``--user`` parameter is the user who started the kyuubi server.
174160

175-
.. _list_engines:
176-
177161
List engine
178162
***********
179163

@@ -189,19 +173,15 @@ The management share level is SERVER, the user who starts the kyuubi server is A
189173
190174
bin/kyuubi-ctl list engine --user A --engine-type TRINO --engine-subdomain adhoc --engine-share-level SERVER
191175
192-
.. _get_engines:
193-
194176
Get engine
195-
***********
177+
**********
196178

197179
Get Kyuubi engine info belong to a user.
198180

199181
.. code-block:: bash
200182
201183
bin/kyuubi-ctl get engine --user AAA --host XXX --port YYY
202184
203-
.. _delete_engines:
204-
205185
Delete engine
206186
*************
207187

@@ -211,4 +191,4 @@ After the engine node is deleted, the kyuubi engine stops opening new sessions a
211191

212192
.. code-block:: bash
213193
214-
bin/kyuubi-ctl delete engine --user AAA --host XXX --port YYY
194+
bin/kyuubi-ctl delete engine --user AAA --host XXX --port YYY

0 commit comments

Comments
 (0)