-
Notifications
You must be signed in to change notification settings - Fork 948
docs(client): Add comprehensive docs for Engine Pool feature #7118
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: master
Are you sure you want to change the base?
Conversation
The documentation for the Engine Pool feature was previously missing. This commit introduces a complete guide to help users understand, configure, and use this feature effectively. This new document (`engine_pool.md`) covers: - An overview of the feature's purpose and mechanism. - Detailed descriptions of all configuration parameters (e.g., `kyuubi.engine.pool.size`). - Clarification on configuration precedence. - Step-by-step instructions and practical examples for setup. Additionally, the file format has been updated from `.rst` to Markdown (`.md`) for consistency with other project documentation.
I suggest embedding the engine pool description into the existing Engine Share Level page since engine pool is one specific case of the subdomain utilization |
An additional comment about AI-generated comments/articles, I'm not against that, but it's usually too wordy for technical docs, please keep the words short and clear. |
Thanks for the great suggestions. That makes total sense. I'll embed the content into the existing page and make the wording more concise. Will push the update shortly. |
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #7118 +/- ##
=======================================
Coverage 0.00% 0.00%
=======================================
Files 697 700 +3
Lines 43214 43374 +160
Branches 5855 5873 +18
=======================================
- Misses 43214 43374 +160 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
The documentation for the Engine Pool feature was previously missing. This commit introduces a complete guide to help users understand, configure, and use this feature effectively.
This new document (
engine_pool.md
) covers:kyuubi.engine.pool.size
).Additionally, the file format has been updated from
.rst
to Markdown (.md
) for consistency with other project documentation.Why are the changes needed?
The Engine Pool is a key feature for improving concurrency and resource utilization, but its documentation was absent. This made it challenging for users to discover and leverage this functionality. This PR provides a complete guide to enable users to effectively use the Engine Pool feature.
How was this patch tested?
This is a documentation-only change. The following has been verified:
Was this patch authored or co-authored using generative AI tooling?
Yes. Generative AI tools were used in several stages of preparing this contribution:
Generated-by: Claude 4, Gemini 2.5 pro