Skip to content

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

Open
wants to merge 5 commits into
base: master
Choose a base branch
from

Conversation

z1131392774
Copy link

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.

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:

  • The Markdown content renders correctly in GitHub's preview.
  • The technical explanations and configuration parameters are accurate.

Was this patch authored or co-authored using generative AI tooling?

Yes. Generative AI tools were used in several stages of preparing this contribution:

  • The initial draft of the documentation was written with the assistance of Claude.
  • Revisions and suggestions were provided by Gemini.
  • Commit messages and pull request descriptions were refined for clarity using Gemini.

Generated-by: Claude 4, Gemini 2.5 pro

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.
@github-actions github-actions bot added the kind:documentation Documentation is a feature! label Jun 27, 2025
@pan3793 pan3793 requested a review from yaooqinn July 2, 2025 10:10
@pan3793
Copy link
Member

pan3793 commented Jul 2, 2025

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

@pan3793
Copy link
Member

pan3793 commented Jul 2, 2025

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.

@z1131392774
Copy link
Author

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-commenter
Copy link

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 0.00%. Comparing base (364f062) to head (4d34a5b).
Report is 10 commits behind head on master.

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.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind:documentation Documentation is a feature!
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants