Closed
Conversation
Signed-off-by: Denis Krivenko <dnskrv88@gmail.com>
pan3793
approved these changes
Mar 23, 2026
cxzl25
approved these changes
Mar 23, 2026
There was a problem hiding this comment.
Pull request overview
Fixes broken/incorrect intra-site documentation links (largely around configuration and quick-start pages) following the move to Sphinx + MyST and some previously incorrect relative paths.
Changes:
- Update multiple doc references from incorrect
settings.html/local paths to the correctconfiguration/settingspage and anchors. - Fix an AQE self-link to use an in-page anchor instead of
aqe.html#.... - Update several client docs to point at the correct Quick Start / JDBC driver pages.
Reviewed changes
Copilot reviewed 10 out of 10 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
| docs/security/ldap.md | Updates LDAP settings reference to the correct configuration settings page/anchor. |
| docs/deployment/spark/dynamic_allocation.md | Fixes links to the correct configuration settings anchors (spark-defaults, user defaults, JDBC URL). |
| docs/deployment/spark/aqe.md | Fixes an in-page anchor link and updates settings references to correct paths/anchors. |
| docs/deployment/high_availability_guide.md | Fixes HA settings link to point at the correct configuration section. |
| docs/deployment/engine_on_yarn.md | Fixes “Kyuubi Kinit” link to point at the correct configuration section. |
| docs/deployment/engine_lifecycle.md | Updates engine share-level link target; keeps cross-doc navigation consistent. |
| docs/client/rest/rest_api.md | Updates user-defaults settings link to the correct configuration anchor. |
| docs/client/jdbc/hive_jdbc.md | Updates links to the JDBC driver doc and Quick Start index. |
| docs/client/bi_tools/hue.md | Updates Quick Start link target. |
| docs/client/bi_tools/datagrip.md | Updates Quick Start link target. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| ### Get Kyuubi Started | ||
|
|
||
| [Get the server Started](../../quick_start/quick_start.html) first before your try Hue with Kyuubi. | ||
| [Get the server Started](../../quick_start/quick_start.rst) first before your try Hue with Kyuubi. |
There was a problem hiding this comment.
The sentence has a grammatical typo: “before your try Hue…” should be “before you try Hue…”.
Suggested change
| [Get the server Started](../../quick_start/quick_start.rst) first before your try Hue with Kyuubi. | |
| [Get the server Started](../../quick_start/quick_start.rst) first before you try Hue with Kyuubi. |
| ### Get Kyuubi Started | ||
|
|
||
| [Get kyuubi server started](../../quick_start/quick_start.html) before you try DataGrip with kyuubi. | ||
| [Get kyuubi server started](../../quick_start/quick_start.rst) before you try DataGrip with kyuubi. |
There was a problem hiding this comment.
Brand/capitalization typo in the link sentence: “Get kyuubi server started” should use “Kyuubi” (and ideally consistent capitalization).
| The above two configurations can be used together to set the TTL of engines. | ||
| These configurations are user-facing and able to use in JDBC urls. | ||
| Note that, for [connection](engine_share_level.html#connection) share level engines that will be terminated at once when the connection is disconnected, these configurations not necessarily work in this case. | ||
| Note that, for [connection](engine_share_level.md#connection) share level engines that will be terminated at once when the connection is disconnected, these configurations not necessarily work in this case. |
There was a problem hiding this comment.
Grammar: “these configurations not necessarily work” should be “these configurations do not necessarily work”.
Suggested change
| Note that, for [connection](engine_share_level.md#connection) share level engines that will be terminated at once when the connection is disconnected, these configurations not necessarily work in this case. | |
| Note that, for [connection](engine_share_level.md#connection) share level engines that will be terminated at once when the connection is disconnected, these configurations do not necessarily work in this case. |
| ### POST /admin/refresh/user_defaults_conf | ||
|
|
||
| Refresh the [user defaults configs](../../configuration/settings.html#user-defaults) with key in format in the form of `___{username}___.{config key}` from default property file. | ||
| Refresh the [user defaults configs](../../configuration/settings.md#user-defaults) with key in format in the form of `___{username}___.{config key}` from default property file. |
There was a problem hiding this comment.
Wording is currently redundant/unclear: “with key in format in the form of …” repeats itself. Consider rephrasing to a single clear clause describing the expected key format.
Suggested change
| Refresh the [user defaults configs](../../configuration/settings.md#user-defaults) with key in format in the form of `___{username}___.{config key}` from default property file. | |
| Refresh the [user defaults configs](../../configuration/settings.md#user-defaults) whose keys have the form `___{username}___.{config key}` from the default property file. |
Contributor
Author
|
Merged to master and branch-1.11 |
dnskr
added a commit
that referenced
this pull request
Mar 23, 2026
### Why are the changes needed? The PR fixes broken links in the documentation. Some links broke after [replacing recommonmark with myst](#7237), while others (like [kyuubi 1.9.4/aqe](https://kyuubi.readthedocs.io/en/v1.9.4/deployment/spark/aqe.html#:~:text=Configuring%20by%20spark%2Ddefaults.conf)) used incorrect paths and were already broken before the change. ### How was this patch tested? Built the documentation with the following command and verified the fixed links manually: ```shell make html ``` ### Was this patch authored or co-authored using generative AI tooling? No Closes #7365 from dnskr/docs-fix-links. Closes #7365 9dcbeed [Denis Krivenko] [DOC] Fix links Authored-by: Denis Krivenko <dnskrv88@gmail.com> Signed-off-by: Denis Krivenko <dnskrv88@gmail.com> (cherry picked from commit 7969f85) Signed-off-by: Denis Krivenko <dnskrv88@gmail.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Why are the changes needed?
The PR fixes broken links in the documentation.
Some links broke after replacing recommonmark with myst, while others (like kyuubi 1.9.4/aqe) used incorrect paths and were already broken before the change.
How was this patch tested?
Built the documentation with the following command and verified the fixed links manually:
Was this patch authored or co-authored using generative AI tooling?
No